{
"openapi": "3.0.1",
"info": {
"title": "HCL Commerce Services - API Extensions",
"description": "Provide API Extensions for HCL Commerce.",
"version": "9.1.20.0",
"x-introduced": "9.1.0.0"
},
"servers": [
{
"url": "https://{hostname}:{port}/commerceue/extension",
"variables": {
"port": {
"default": "443",
"enum": [
"443",
"9443"
]
},
"hostname": {
"default": "localhost",
"enum": [
"localhost",
"test.hcl.com"
]
}
}
}
],
"externalDocs": {
"description": "For some parts of HCL Commerce, you can write extension code to extend HCL Commerce controller or task commands. \n\n",
"url": "https://help.hcltechsw.com/commerce/9.1.0/developer/concepts/cde_xcoverview.html?hl=xc%2Cextension%2Cpoints"
},
"tags": [
{
"name": "inventory",
"description": "API Extensions for inventory customization."
},
{
"name": "person",
"description": "API Extensions for person customization."
},
{
"name": "customjob",
"description": "API Extensions for order scheduler job customization."
},
{
"name": "order",
"description": "API Extensions for order customization."
},
{
"name": "payment",
"description": "API Extensions for payment customization."
}
],
"paths": {
"/inventory/inventory_update": {
"post": {
"tags": [
"inventory"
],
"summary": "The API extension for ChangeInventoryAvailabilityBasePartExtCmd task command.",
"description": "| Command: com.ibm.commerce.inventory.task.commands.ChangeInventoryAvailabilityBasePartExtCmd |\n|----------|\n| ChangeInventoryAvailabilityBasePartExtCmd task command provides customers the ability to synchronize inventory services|",
"operationId": "updateInventoryQuantity",
"requestBody": {
"description": "ChangeInventoryAvailabilityBasePartExtCmdUEInput UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeInventoryAvailabilityBasePartExtCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeInventoryAvailabilityBasePartExtCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.inventory.task.commands.ChangeInventoryAvailabilityBasePartExtCmd"
},
"x-codegen-request-body-name": "ChangeInventoryAvailabilityBasePartExtCmdUEInput"
}
},
"/order/compensate_transaction": {
"post": {
"tags": [
"order"
],
"summary": "The compensation for transaction rollback",
"description": "Command: com.ibm.commerce.foundation.ue.compensation.CompensateForTxRollbackCmd",
"operationId": "compensateForTxTransanction",
"requestBody": {
"description": "The compensateForTxTransanction UE input parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompensateForTxRollbackCmdUEInput"
}
}
},
"required": true
},
"responses": {
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.foundation.ue.compensation.CompensateForTxRollbackCmd"
},
"x-codegen-request-body-name": "compensateForTxTransanction UE input"
}
},
"/order/customjob_batch_order_message": {
"post": {
"tags": [
"customjob"
],
"summary": "The replace API extension for CustomJobCmd controller command.",
"description": "| Command: com.ibm.commerce.scheduler.commands.CustomJobCmd |\n|----------|\n| CustomJobCmd is a controller command which calls out to the scheduler xC.|",
"operationId": "OrderCustomJobMessage",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderCustomJobUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.scheduler.commands.CustomJobCmd"
},
"x-codegen-request-body-name": "OrderCustomJUEReplace UE input"
}
},
"/order/ext_order_process": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for ExtOrderProcessCmd task command.",
"description": "| Command: com.ibm.commerce.order.commands.ExtOrderProcessCmd |\n|----------|\n| ExtOrderProcessCmd is a task command which is used to perform custom processing just prior to the completion of the OrderProcessCmd controller command.|",
"operationId": "extOrderProcessCus",
"requestBody": {
"description": "ExtOrderProcessCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtOrderProcessCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtOrderProcessCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.ExtOrderProcessCmd"
},
"x-codegen-request-body-name": "ExtOrderProcessCmdUEInput"
}
},
"/order/order_calculate_post": {
"post": {
"tags": [
"order"
],
"summary": "The post API extension for OrderCalculateCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderCalculateCmd |\n|----------|\n| OrderCalculateCmd is a controller command which is used to re-calculate specified calculation usages.
This command is called by OrderItemBaseCmdImpl and OrderItemDeleteCmdImpl to refresh the order price, charges and freebie items after Add, Update and Delete order item.
|",
"operationId": "OrderCalculatePost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderCalculateCmd"
},
"x-codegen-request-body-name": "OrderCalculateCmdPost UE input"
}
},
"/order/order_calculate_pre": {
"post": {
"tags": [
"order"
],
"summary": "The pre API extension for OrderCalculateCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderCalculateCmd |\n|----------|\n| OrderCalculateCmd is a controller command which is used to re-calculate specified calculation usages.
This command is called by OrderItemBaseCmdImpl and OrderItemDeleteCmdImpl to refresh the order price, charges and freebie items after Add, Update and Delete order item.
|",
"operationId": "OrderCalculatePre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderCalculateCmd"
},
"x-codegen-request-body-name": "OrderCalculateCmdPre UE input"
}
},
"/order/order_calculate_replace": {
"post": {
"tags": [
"order"
],
"summary": "The replace API extension for OrderCalculateCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderCalculateCmd |\n|----------|\n| OrderCalculateCmd is a controller command which is used to re-calculate specified calculation usages.
This command is called by OrderItemBaseCmdImpl and OrderItemDeleteCmdImpl to refresh the order price, charges and freebie items after Add, Update and Delete order item.
|",
"operationId": "OrderCalculateReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderCalculateCmd"
},
"x-codegen-request-body-name": "OrderCalculateCmdReplace UE input"
}
},
"/order/order_item_add_post": {
"post": {
"tags": [
"order"
],
"summary": "The post API extension for orderItemAddCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemAddCmd |\n|----------|\n| OrderItemAddCmd is a controller command which is used to add items to one or a list of orders.|",
"operationId": "orderItemAddPost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemAddCmd"
},
"x-codegen-request-body-name": "orderItemAddPost UE input"
}
},
"/order/order_item_add_pre": {
"post": {
"tags": [
"order"
],
"summary": "The pre API extension for orderItemAddCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemAddCmd |\n|----------|\n| OrderItemAddCmd is a controller command which is used to add items to one or a list of orders.|",
"operationId": "orderItemAddPre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemAddCmd"
},
"x-codegen-request-body-name": "orderItemAddPre UE input"
}
},
"/order/order_item_add_replace": {
"post": {
"tags": [
"order"
],
"summary": "The replace API extension for orderItemAddCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemAddCmd |\n|----------|\n| OrderItemAddCmd is a controller command which is used to add items to one or a list of orders.|",
"operationId": "orderItemAddReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemAddCmd"
},
"x-codegen-request-body-name": "orderItemAddReplace UE input"
}
},
"/order/order_item_delete_post": {
"post": {
"tags": [
"order"
],
"summary": "The post API extension for OrderItemDeleteCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd |\n|----------|\n| OrderItemDeleteCmd is a controller command which is used to delete some order items from one or more pending orders for some orderitemIds or product.|",
"operationId": "OrderItemDeletePost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd"
},
"x-codegen-request-body-name": "OrderDeleteCmdPoste UE input"
}
},
"/order/order_item_delete_pre": {
"post": {
"tags": [
"order"
],
"summary": "The pre API extension for OrderItemDeleteCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd |\n|----------|\n| OrderItemDeleteCmd is a controller command which is used to delete some order items from one or more pending orders for some orderitemIds or product.|",
"operationId": "OrderItemDeletePre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd"
},
"x-codegen-request-body-name": "OrderDeleteCmdPre UE input"
}
},
"/order/order_item_delete_replace": {
"post": {
"tags": [
"order"
],
"summary": "The replace API extension for OrderItemDeleteCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd |\n|----------|\n| OrderItemDeleteCmd is a controller command which is used to delete some order items from one or more pending orders for some orderitemIds or product.|",
"operationId": "OrderItemDeleteReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemDeleteCmd"
},
"x-codegen-request-body-name": "OrderDeleteCmdReplace UE input"
}
},
"/order/order_item_update_post": {
"post": {
"tags": [
"order"
],
"summary": "The post API extension for orderItemUpdateCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemUpdateCmd |\n|----------|\n| orderItemUpdateCmd is a controller command which is used to Updates one or more order items in the shopping cart.|",
"operationId": "orderItemUpdatePost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemUpdateCmd"
},
"x-codegen-request-body-name": "orderItemUpdateCmdPost UE input"
}
},
"/order/order_item_update_pre": {
"post": {
"tags": [
"order"
],
"summary": "The pre API extension for orderItemUpdateCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemUpdateCmd |\n|----------|\n| orderItemUpdateCmd is a controller command which is used to Updates one or more order items in the shopping cart.|",
"operationId": "orderItemUpdatePre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemUpdateCmd"
},
"x-codegen-request-body-name": "orderItemUpdateCmdPre UE input"
}
},
"/order/order_item_update_replace": {
"post": {
"tags": [
"order"
],
"summary": "The replace API extension for orderItemUpdateCmd controller command.",
"description": "| Command: com.ibm.commerce.orderitems.commands.OrderItemUpdateCmd |\n|----------|\n| orderItemUpdateCmd is a controller command which is used to Updates one or more order items in the shopping cart.|",
"operationId": "orderItemUpdateReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemUpdateCmd"
},
"x-codegen-request-body-name": "orderItemUpdateCmdReplace UE input"
}
},
"/order/order_messaging": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for OrderMessagingCmd task command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderMessagingCmd |\n|----------|\n| OrderMessagingCmd is a task command that generates the outbound Order Create Message \"Report_NC_PurchaseOrder\".|",
"operationId": "orderMessagingCus",
"requestBody": {
"description": "OrderMessaging UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderMessagingCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderMessagingCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderMessagingCmd"
},
"x-codegen-request-body-name": "OrderMessagingUEInput"
}
},
"/order/order_notify": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for OrderNotifyCmd task command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderNotifyCmd |\n|----------|\n| OrderNotifyCmd is task command is used to Sends order notification message.|",
"operationId": "orderNotifyCus",
"requestBody": {
"description": "OrderNotify UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderNotifyCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderNotifyCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderNotifyCmd"
},
"x-codegen-request-body-name": "OrderNotifyUEInput"
}
},
"/order/order_prepare_post": {
"post": {
"tags": [
"order"
],
"summary": "The post API extension for OrderPrepareCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderPrepareCmd |\n|----------|\n| OrderPrepareCmd is a controller command which is used to prepare an order by determining prices, discounts, shipping charges, shipping adjustment,and taxes for an order. If an order reference number is not specified,all current pending orders will be prepared for the current customer at the given store.|",
"operationId": "OrderPreparePost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderPrepareCmd"
},
"x-codegen-request-body-name": "OrderPrepareCmdPre UE input"
}
},
"/order/order_prepare_pre": {
"post": {
"tags": [
"order"
],
"summary": "The pre API extension for OrderPrepareCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderPrepareCmd |\n|----------|\n| OrderPrepareCmd is a controller command which is used to prepare an order by determining prices, discounts, shipping charges, shipping adjustment,and taxes for an order. If an order reference number is not specified,all current pending orders will be prepared for the current customer at the given store.|",
"operationId": "OrderPreparePre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderPrepareCmd"
},
"x-codegen-request-body-name": "OrderPrepareCmdPre UE input"
}
},
"/order/order_prepare_replace": {
"post": {
"tags": [
"order"
],
"summary": "The replace API extension for OrderPrepareCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderPrepareCmd |\n|----------|\n| OrderPrepareCmd is a controller command which is used to prepare an order by determining prices, discounts, shipping charges, shipping adjustment,and taxes for an order. If an order reference number is not specified,all current pending orders will be prepared for the current customer at the given store.|",
"operationId": "OrderPrepareReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderPrepareCmd"
},
"x-codegen-request-body-name": "OrderPrepareCmdReplace UE input"
}
},
"/order/order_process_post": {
"post": {
"tags": [
"order"
],
"summary": "The post API extension for OrderProcessCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderProcessCmd |\n|----------|\n| OrderProcessCmd is a controller command which is used to submit an order. The order must have been locked by OrderPrepare. Once the OrderProcess command begins running, the order cannot be cancelled with OrderCancel.|",
"operationId": "OrderProcessPost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderProcessCmd"
},
"x-codegen-request-body-name": "OrderProcessCmdPost UE input"
}
},
"/order/order_process_pre": {
"post": {
"tags": [
"order"
],
"summary": "The pre API extension for OrderProcessCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderProcessCmd |\n|----------|\n| OrderProcessCmd is a controller command which is used to submit an order. The order must have been locked by OrderPrepare. Once the OrderProcess command begins running, the order cannot be cancelled with OrderCancel.|",
"operationId": "OrderProcessPre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderProcessCmd"
},
"x-codegen-request-body-name": "OrderProcessCmdPre UE input"
}
},
"/order/order_process_replace": {
"post": {
"tags": [
"order"
],
"summary": "The replace API extension for OrderProcessCmd controller command.",
"description": "| Command: com.ibm.commerce.order.commands.OrderProcessCmd |\n|----------|\n| OrderProcessCmd is a controller command which is used to submit an order. The order must have been locked by OrderPrepare. Once the OrderProcess command begins running, the order cannot be cancelled with OrderCancel.|",
"operationId": "OrderProcessReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.OrderProcessCmd"
},
"x-codegen-request-body-name": "OrderProcessCmdReplace UE input"
}
},
"/order/pre_process_order": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for PreProcessOrder task command.",
"description": "| Command: com.ibm.commerce.order.commands.PreProcessOrderCmd |\n|----------|\n| PreProcessOrderCmd is a task command which is used to pre process the order, it's called before the calling of ProcessOrderCmd.|",
"operationId": "preProcessOrderCus",
"requestBody": {
"description": "PreProcessOrder UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreProcessOrderCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreProcessOrderCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.PreProcessOrderCmd"
},
"x-codegen-request-body-name": "PreProcessOrderUEInput"
}
},
"/order/process_order": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for ProcessOrderCmd task command.",
"description": "| Command: com.ibm.commerce.order.commands.ProcessOrderCmd |\n|----------|\n| ProcessOrderCmd is a task command which is used to submit an order.|",
"operationId": "processOrderCus",
"requestBody": {
"description": "ProcessOrderCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessOrderCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessOrderCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.ProcessOrderCmd"
},
"x-codegen-request-body-name": "ProcessOrderUEInput"
}
},
"/order/process_order_submit_event": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for ProcessOrderSubmitEventCmd task command.",
"description": "| Command: com.ibm.commerce.order.commands.ProcessOrderSubmitEventCmd |\n|----------|\n| ProcessOrderSubmitEventCmd is a task command which is used to process the event captured by the listener when the event name is order submit.|",
"operationId": "processOrderSubmitEvent",
"requestBody": {
"description": "ProcessOrderSubmitEventCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessOrderSubmitEventCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessOrderSubmitEventCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.ProcessOrderSubmitEventCmd"
},
"x-codegen-request-body-name": "ProcessOrderSubmitEventCmdUEInput"
}
},
"/order/process_promotion_code": {
"post": {
"tags": [
"order"
],
"summary": "The process_promotion_code command processes the promotion code - return the real promotion code, or throw exception.",
"description": "| Command: com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd |\n|----------|\n| PromotionCodeAddRemoveControllerCmd is a controller command which is used to add or remove a promotion code from an order.|",
"operationId": "processPromotionCode",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd"
},
"x-codegen-request-body-name": "processPromotionCode UE input"
}
},
"/order/promotion_code_add_remove_post": {
"post": {
"tags": [
"order"
],
"summary": "The post API extension for PromotionCodeAddRemoveControllerCmd controller command.",
"description": "| Command: com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd |\n|----------|\n| PromotionCodeAddRemoveControllerCmd is a controller command which is used to add or remove a promotion code from an order.|",
"operationId": "promotionCodeAddRemovePost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd"
},
"x-codegen-request-body-name": "promotionCodeAddRemovePost UE input"
}
},
"/order/promotion_code_add_remove_pre": {
"post": {
"tags": [
"order"
],
"summary": "The pre API extension for PromotionCodeAddRemoveControllerCmd controller command.",
"description": "| Command: com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd |\n|----------|\n| PromotionCodeAddRemoveControllerCmd is a controller command which is used to add or remove a promotion code from an order.|",
"operationId": "promotionCodeAddRemovePre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd"
},
"x-codegen-request-body-name": "promotionCodeAddRemovePre UE input"
}
},
"/order/promotion_code_add_remove_replace": {
"post": {
"tags": [
"order"
],
"summary": "The replace API extension for PromotionCodeAddRemoveControllerCmd controller command.",
"description": "| Command: com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd |\n|----------|\n| PromotionCodeAddRemoveControllerCmd is a controller command which is used to add or remove a promotion code from an order.|",
"operationId": "promotionCodeAddRemoveReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.marketing.commands.PromotionCodeAddRemoveControllerCmd"
},
"x-codegen-request-body-name": "promotionCodeAddRemoveReplace UE input"
}
},
"/order/tax_integration_custom": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for TaxIntegrationCustom task command.",
"description": "| Command: com.ibm.commerce.isv.kit.tax.TaxIntegrationCustomCmd |\n|----------|\n| TaxIntegrationCustomCmd is a task command which is used to custom the tax integration by CoC Customization framework.|",
"operationId": "taxIntegrationOrderCus",
"requestBody": {
"description": "TaxIntegrationCustomCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxIntegrationCustomCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaxIntegrationCustomCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.isv.kit.tax.TaxIntegrationCustomCmd"
},
"x-codegen-request-body-name": "TaxIntegrationCustomCmdUEInput"
}
},
"/order/update_shipping_address": {
"post": {
"tags": [
"order"
],
"summary": "The API extension for UpdateShippingAddressCmd task command.",
"description": "| Command: com.ibm.commerce.order.commands.UpdateShippingAddressCmd |\n|----------|\n| UpdateShippingAddressCmd is a task command which is used to update the shipping address for the passed order items.|",
"operationId": "updateShippingAddressCus",
"requestBody": {
"description": "UpdateShippingAddress UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateShippingAddressCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateShippingAddressCmdUEOutput"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.order.commands.UpdateShippingAddressCmd"
},
"x-codegen-request-body-name": "UpdateShippingAddressUEInput"
}
},
"/order/validate_quantity": {
"post": {
"tags": [
"order"
],
"summary": "The validate_quantity command validates the quantity limitation against the order.",
"description": "Command: com.ibm.commerce.orderitems.commands.OrderItemAddCmd",
"operationId": "validateQuantity",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPreUEResponse"
}
}
}
},
"400": {
"description": "Invalid Input Parameter",
"content": {}
},
"500": {
"description": "Invalid Input Parameter",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.orderitems.commands.OrderItemAddCmd"
},
"x-codegen-request-body-name": "validateQuantity UE input"
}
},
"/payment/approve_and_deposit_payment": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for PaymentApproveAndDepositCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.PaymentApproveAndDepositCmd |\n|----------|\n| PaymentApproveAndDepositCmd is a task command which is used to authorize the payment.|",
"operationId": "approveAndDepositPayment",
"requestBody": {
"description": "PaymentApproveAndDepositCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentApproveAndDepositCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentApproveAndDepositCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.PaymentApproveAndDepositCmd"
},
"x-codegen-request-body-name": "PaymentApproveAndDepositCmdUEInput"
}
},
"/payment/approve_payment": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for PaymentApproveCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.PaymentApproveCmd |\n|----------|\n| PaymentApproveCmd is a task command which is used to authorize the payment.|",
"operationId": "approvePayment",
"requestBody": {
"description": "PaymentApproveCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentApproveCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentApproveCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.ProcessPunchoutResponseCmd"
},
"x-codegen-request-body-name": "PaymentApproveCmdUEInput"
}
},
"/payment/approve_payment_applepay": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for PaymentApproveCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.PaymentApproveCmd |\n|----------|\n| PaymentApproveCmd is a task command which is used to authorize the payment.|",
"operationId": "approvePaymentApplePay",
"requestBody": {
"description": "PaymentApproveCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentApproveCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentApproveCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-codegen-request-body-name": "PaymentApproveCmdUEInput"
}
},
"/payment/clean_session": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for SessionCleanCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.SessionCleanCmd |\n|----------|\n| SessionCleanCmd is a task command which is used to clean the pending and expired payments.|",
"operationId": "cleanSession",
"requestBody": {
"description": "SessionCleanCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionCleanCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionCleanCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.SessionCleanCmd"
},
"x-codegen-request-body-name": "SessionCleanCmdUEInput"
}
},
"/payment/create_payment_token": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for CreatePaymentTokenCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.CreatePaymentTokenCmd |\n|----------|\n| CreatePaymentTokenCmd is a task command which is used to create the payment token.|",
"operationId": "createPaymentToken",
"requestBody": {
"description": "CreatePaymentTokenCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePaymentTokenCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePaymentTokenCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-codegen-request-body-name": "CreatePaymentTokenCmdUEInput"
}
},
"/payment/credit_payment": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for PaymentCreditCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.PaymentCreditCmd |\n|----------|\n| PaymentCreditCmd is a task command which is used to authorize the payment.|",
"operationId": "creditPayment",
"requestBody": {
"description": "PaymentCreditCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentCreditCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentCreditCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.PaymentCreditCmd"
},
"x-codegen-request-body-name": "PaymentCreditCmdUEInput"
}
},
"/payment/deposit_payment": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for PaymentDepositCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.PaymentDepositCmd |\n|----------|\n| PaymentDepositCmd is a task command which is used to authorize the payment.|",
"operationId": "depositPayment",
"requestBody": {
"description": "PaymentDepositCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentDepositCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentDepositCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.PaymentDepositCmd"
},
"x-codegen-request-body-name": "PaymentDepositCmdUEInput"
}
},
"/payment/fetch_payment_token": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for FetchPaymentTokenCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.FetchPaymentTokenCmd |\n|----------|\n| FetchPaymentTokenCmd is a task command which is used to fetch the payment token.|",
"operationId": "fetchPaymentToken",
"requestBody": {
"description": "FetchPaymentTokenCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchPaymentTokenCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchPaymentTokenCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-codegen-request-body-name": "FetchPaymentTokenCmdUEInput"
}
},
"/payment/get_punchout_url": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for GetPunchoutURLCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.GetPunchoutURLCmd |\n|----------|\n| GetPunchoutURLCmd is a task command which is used to compose the payment punchout url.|",
"operationId": "getPunchoutURL",
"requestBody": {
"description": "GetPunchoutURLCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPunchoutURLCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPunchoutURLCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.GetPunchoutURLCmd"
},
"x-codegen-request-body-name": "GetPunchoutURLCmdUEInput"
}
},
"/payment/process_punchout_response": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for ProcessPunchoutResponseCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.ProcessPunchoutResponseCmd |\n|----------|\n| ProcessPunchoutResponseCmd is a task command which is used to process the provider response data.|",
"operationId": "processPunchoutResponse",
"requestBody": {
"description": "ProcessPunchoutResponseCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessPunchoutResponseCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessPunchoutResponseCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.ProcessPunchoutResponseCmd"
},
"x-codegen-request-body-name": "ProcessPunchoutResponseCmdUEInput"
}
},
"/payment/remove_payment_token": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for RemovePaymentTokenCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.RemovePaymentTokenCmd |\n|----------|\n| RemovePaymentTokenCmd is a task command which is used to remove the payment token.|",
"operationId": "removePaymentToken",
"requestBody": {
"description": "RemovePaymentTokenCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemovePaymentTokenCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemovePaymentTokenCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-codegen-request-body-name": "RemovePaymentTokenCmdUEInput"
}
},
"/payment/reverse_approval": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for PaymentReverseApprovalCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.PaymentReverseApprovalCmd |\n|----------|\n| PaymentReverseApprovalCmd is a task command which is used to authorize the payment.|",
"operationId": "reverseApproval",
"requestBody": {
"description": "PaymentReverseApprovalCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentReverseApprovalCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentReverseApprovalCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.PaymentReverseApprovalCmd"
},
"x-codegen-request-body-name": "PaymentReverseApprovalCmdUEInput"
}
},
"/payment/reverse_deposit": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for PaymentReverseDepositCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.PaymentReverseDepositCmd |\n|----------|\n| PaymentReverseDepositCmd is a task command which is used to authorize the payment.|",
"operationId": "reverseDeposit",
"requestBody": {
"description": "PaymentReverseDepositCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentReverseDepositCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentReverseDepositCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.payment.task.commands.PaymentReverseDepositCmd"
},
"x-codegen-request-body-name": "PaymentReverseDepositCmdUEInput"
}
},
"/payment/update_payment_token": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for UpdatePaymentTokenCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.UpdatePaymentTokenCmd |\n|----------|\n| UpdatePaymentTokenCmd is a task command which is used to update the payment token.|",
"operationId": "updatePaymentToken",
"requestBody": {
"description": "UpdatePaymentTokenCmd UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentTokenCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePaymentTokenCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-codegen-request-body-name": "UpdatePaymentTokenCmdUEInput"
}
},
"/payment/verify_payment_account": {
"post": {
"tags": [
"payment"
],
"summary": "The API extension for VerifyPaymentAccountCmd task command.",
"description": "| Command: com.ibm.commerce.payment.task.commands.VerifyPaymentAccountCmd |\n|----------|\n| VerifyPaymentAccountCmd is a task command which is used to verify the payment account.|",
"operationId": "verifyPaymentAccount",
"requestBody": {
"description": "VerifyPaymentAccountCmdUEInput UE Input Parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyPaymentAccountCmdUEInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyPaymentAccountCmdUEOutput"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-codegen-request-body-name": "VerifyPaymentAccountCmdUEInput"
}
},
"/person/person_register_post": {
"post": {
"tags": [
"person"
],
"summary": "The post API extension for UserRegistrationAddCmd controller command.",
"description": "| Command: com.ibm.commerce.usermanagement.commands.UserRegistrationAddCmd |\n|----------|\n| UserRegistrationAddCmd is a controller command which is used to register a new shopper|",
"operationId": "personRegisterPost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPostUEResponse"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.usermanagement.commands.UserRegistrationAddCmd"
},
"x-codegen-request-body-name": "personRegisterPost UE input"
}
},
"/person/person_register_pre": {
"post": {
"tags": [
"person"
],
"summary": "The pre API extension for UserRegistrationAddCmd controller command.",
"description": "| Command: com.ibm.commerce.usermanagement.commands.UserRegistrationAddCmd |\n|----------|\n| UserRegistrationAddCmd is a controller command which is used to register a new shopper|",
"operationId": "personRegisterPre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPreUEResponse"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.usermanagement.commands.UserRegistrationAddCmd"
},
"x-codegen-request-body-name": "personRegisterPre UE input"
}
},
"/person/person_register_replace": {
"post": {
"tags": [
"person"
],
"summary": "The replace API extension for UserRegistrationAddCmd controller command.",
"description": "| Command: com.ibm.commerce.usermanagement.commands.UserRegistrationAddCmd |\n|----------|\n| UserRegistrationAddCmd is a controller command which is used to register a new shopper|",
"operationId": "personRegisterReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonReplaceUEResponse"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.usermanagement.commands.UserRegistrationAddCmd"
},
"x-codegen-request-body-name": "personRegisterReplace UE input"
}
},
"/person/person_update_post": {
"post": {
"tags": [
"person"
],
"summary": "The post API extension for UserRegistrationUpdateCmd controller command.",
"description": "| Command: com.ibm.commerce.usermanagement.commands.UserRegistrationUpdateCmd |\n|----------|\n| UserRegistrationUpdateCmd is a controller command which is used to update existing shopper|",
"operationId": "personUpdatePost",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPostUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPostUEResponse"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.usermanagement.commands.UserRegistrationUpdateCmd"
},
"x-codegen-request-body-name": "personUpdatePost UE input"
}
},
"/person/person_update_pre": {
"post": {
"tags": [
"person"
],
"summary": "The pre API extension for UserRegistrationUpdateCmd controller command.",
"description": "| Command: com.ibm.commerce.usermanagement.commands.UserRegistrationUpdateCmd |\n|----------|\n| UserRegistrationUpdateCmd is a controller command which is used to update existing shopper|",
"operationId": "personUpdatePre",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPreUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonPreUEResponse"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.usermanagement.commands.UserRegistrationUpdateCmd"
},
"x-codegen-request-body-name": "personUpdatePre UE input"
}
},
"/person/person_update_replace": {
"post": {
"tags": [
"person"
],
"summary": "The replace API extension for UserRegistrationUpdateCmd controller command.",
"description": "| Command: com.ibm.commerce.usermanagement.commands.UserRegistrationUpdateCmd |\n|----------|\n| UserRegistrationUpdateCmd is a controller command which is used to update existing shopper|",
"operationId": "personUpdateReplace",
"requestBody": {
"description": "The UE Request String",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonReplaceUERequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonReplaceUEResponse"
}
}
}
},
"400": {
"description": "Application error",
"content": {}
},
"500": {
"description": "System error",
"content": {}
}
},
"x-data-command": {
"Command": "com.ibm.commerce.usermanagement.commands.UserRegistrationUpdateCmd"
},
"x-codegen-request-body-name": "personUpdateReplace UE input"
}
}
},
"components": {
"schemas": {
"FinancialTransactionIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"type": "string"
}
}
},
"OrderItemFulfillmentInfo": {
"type": "object",
"properties": {
"availableDate": {
"type": "string",
"format": "date-time"
},
"expectedShipDate": {
"type": "string",
"format": "date-time"
},
"timeReleased": {
"type": "string",
"format": "date-time"
},
"timeShipped": {
"type": "string",
"format": "date-time"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ContactInfoExternalIdentifier": {
"type": "object",
"properties": {
"contactInfoNickName": {
"type": "string"
},
"personIdentifier": {
"$ref": "#/components/schemas/PersonIdentifier"
},
"organizationIdentifier": {
"$ref": "#/components/schemas/OrganizationIdentifier"
}
}
},
"PersonReplaceUERequest": {
"type": "object",
"properties": {
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"person": {
"$ref": "#/components/schemas/Person"
}
}
},
"PaymentApproveAndDepositCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"UpdateShippingAddressCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"addressIds": {
"type": "array",
"description": "AddressIds which is used to update shipping addresses of order items",
"items": {
"type": "integer",
"format": "int64"
}
},
"validateRequired": {
"type": "boolean",
"description": "Whether shipping address validation is required. The default value is false",
"default": false
},
"defaultAddressUsed": {
"type": "boolean",
"description": "Whether the shipping addresses use the default shipping addresses for registered user. If no other appropriate addresses are found, the default value is true.",
"default": false
},
"shippingAddresses": {
"type": "array",
"description": "The pojo array converted from ShippingAddressAccessBeans",
"items": {
"$ref": "#/components/schemas/ContactInfo"
}
}
},
"description": "This is the UpdateShippingAddressCmd UE output pojo"
},
"Address": {
"type": "object",
"properties": {
"addressLine": {
"type": "array",
"items": {
"type": "string"
}
},
"internalOfficeAddress": {
"type": "string"
},
"city": {
"type": "string"
},
"stateOrProvinceName": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"type": {
"type": "string"
},
"primary": {
"type": "boolean",
"default": false
}
}
},
"CalculationInfo": {
"type": "object",
"properties": {
"usage": {
"type": "string"
},
"priceUpdateFlag": {
"type": "string"
},
"extraAdjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraAdjustment"
}
},
"pricingDate": {
"type": "string",
"format": "date-time"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"OrderBLockInfo": {
"type": "object",
"properties": {
"orderBlock": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderBlock"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"CompensateForTxRollbackCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"ueinvocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UEInvocation"
}
}
}
},
"ScheduleInfo": {
"type": "object",
"properties": {
"startInfo": {
"$ref": "#/components/schemas/ScheduleStartInfo"
},
"frequencyInfo": {
"$ref": "#/components/schemas/ScheduleFrequencyInfo"
},
"endInfo": {
"$ref": "#/components/schemas/ScheduleEndInfo"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"AdjustmentRequirement": {
"type": "object",
"properties": {
"adjustmentUsage": {
"type": "string"
},
"adjustmentCategory": {
"type": "string"
},
"adjustmentValue": {
"type": "string"
},
"comments": {
"$ref": "#/components/schemas/Description"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PaymentDepositCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"CheckoutProfile": {
"type": "object",
"properties": {
"paymentInfo": {
"$ref": "#/components/schemas/PaymentInfo"
},
"shippingInfo": {
"$ref": "#/components/schemas/ShippingInfo"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PreProcessOrderCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"requestProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"responseProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"orderRn": {
"type": "integer",
"description": "The order reference number",
"format": "int64"
},
"billToRn": {
"type": "integer",
"description": "The reference number of the address to bill",
"format": "int64"
},
"notifyMerchant": {
"type": "integer",
"description": "Whether to notify the merchant when the order has been processed",
"format": "int32"
},
"notifyShopper": {
"type": "integer",
"description": "Whether to notify the shopper when the order has been processed",
"format": "int32"
},
"quotationSubmission": {
"type": "string",
"description": "QuotationSubmission parameter"
},
"quoteExpiredURL": {
"type": "string",
"description": "The URL to redirect to if the order total expired in agreement with the expiry policy set by the setQuoteExpiryPolicy method"
},
"quoteExpiryPolicy": {
"type": "string",
"description": "The behavior of the command if the order total expires or an order item's fulfillment center changes during inventory allocation"
},
"maxAvailabilityChange": {
"type": "integer",
"description": "The time interval, in seconds, used with the url set by the setAvailabilityChangeURL method",
"format": "int64"
},
"availabilityChangeURL": {
"type": "string",
"description": "The URL to redirect to"
},
"noInventoryURL": {
"type": "string",
"description": "The URL to redirect to if any of the order items in the order cannot be allocated or backordered"
},
"notifyOrderSubmitted": {
"type": "integer",
"description": "Whether the customer should be notified when the order is successfully submitted",
"format": "int32"
},
"transferMode": {
"type": "string",
"description": "The transferMode property of the command"
},
"poNumber": {
"type": "string",
"description": "PO number"
}
},
"description": "This is the PreProcessOrderCmd UE output pojo"
},
"AssociatedPromotion": {
"type": "object",
"properties": {
"promotionIdentifier": {
"$ref": "#/components/schemas/PromotionIdentifier"
},
"description": {
"$ref": "#/components/schemas/Description"
}
}
},
"FulfillmentCenter": {
"type": "object",
"properties": {
"fulfillmentCenterIdentifier": {
"$ref": "#/components/schemas/FulfillmentCenterIdentifier"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"UpdatePaymentTokenCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"protocolData": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"ContactInfo": {
"type": "object",
"properties": {
"contactInfoIdentifier": {
"$ref": "#/components/schemas/ContactInfoIdentifier"
},
"contactName": {
"$ref": "#/components/schemas/PersonName"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"telephone1": {
"$ref": "#/components/schemas/Telephone"
},
"telephone2": {
"$ref": "#/components/schemas/Telephone"
},
"bestCallingTime": {
"type": "string"
},
"emailAddress1": {
"$ref": "#/components/schemas/EmailAddress"
},
"emailAddress2": {
"$ref": "#/components/schemas/EmailAddress"
},
"fax1": {
"$ref": "#/components/schemas/Fax"
},
"fax2": {
"$ref": "#/components/schemas/Fax"
},
"mobilePhone1": {
"$ref": "#/components/schemas/MobilePhone"
},
"organizationName": {
"type": "string"
},
"organizationUnitName": {
"type": "string"
},
"geographicalShippingCode": {
"type": "string"
},
"geographicalTaxCode": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"language": {
"type": "string"
}
}
},
"PaymentReverseApprovalCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"ChannelIdentifer": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"channelName": {
"type": "string"
}
}
},
"CouponDescription": {
"type": "object",
"properties": {
"shortDescription": {
"type": "string"
},
"longDescription": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"language": {
"type": "string"
}
}
},
"PaymentInfo": {
"type": "object",
"properties": {
"billingAddress": {
"$ref": "#/components/schemas/ContactInfo"
},
"paymentMethod": {
"$ref": "#/components/schemas/PaymentMethod"
},
"protocolData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProtocolData"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"Adjustment": {
"type": "object",
"properties": {
"usage": {
"type": "string"
},
"calculationCodeID": {
"$ref": "#/components/schemas/CalculationCodeIdentifier"
},
"code": {
"type": "string"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"amount": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"displayLevel": {
"type": "string"
},
"isPromotionCodeRequired": {
"type": "boolean",
"default": false
},
"promotionType": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"MonetaryAmount": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"currency": {
"type": "string"
}
}
},
"OrderItemShippingInfo": {
"type": "object",
"properties": {
"shippingAddress": {
"$ref": "#/components/schemas/ContactInfo"
},
"shippingMode": {
"$ref": "#/components/schemas/ShippingMode"
},
"shippingCarrierAccountNumber": {
"type": "string"
},
"shippingInstruction": {
"type": "string"
},
"requestedShipDate": {
"type": "string",
"format": "date-time"
},
"shipTieCode": {
"type": "string"
},
"shippingChargePolicyID": {
"type": "string"
},
"physicalStoreIdentifier": {
"$ref": "#/components/schemas/PhysicalStoreIdentifier"
},
"shippingChargePolicy": {
"$ref": "#/components/schemas/PolicyIdentifier"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"expedite": {
"type": "boolean",
"default": false
}
}
},
"UpdateShippingAddressCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"addressIds": {
"type": "array",
"description": "AddressIds which is used to update shipping addresses of order items",
"items": {
"type": "integer",
"format": "int64"
}
},
"validateRequired": {
"type": "boolean",
"description": "Whether shipping address validation is required. The default value is false",
"default": false
},
"defaultAddressUsed": {
"type": "boolean",
"description": "Whether the shipping addresses use the default shipping addresses for registered user. If no other appropriate addresses are found, the default value is true.",
"default": false
},
"shippingAddresses": {
"type": "array",
"description": "The pojo array converted from ShippingAddressAccessBeans",
"items": {
"$ref": "#/components/schemas/ContactInfo"
}
}
},
"description": "This is the UpdateShippingAddressCmd UE input pojo"
},
"PromotionCode": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"reason": {
"$ref": "#/components/schemas/PromotionCodeReason"
},
"associatedPromotion": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssociatedPromotion"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"GiftSet": {
"type": "object",
"properties": {
"giftItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GiftItem"
}
}
}
},
"OrderNotifyCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"notificationEnabled": {
"type": "boolean",
"description": "Enable or disable order notification",
"default": false
},
"notificationTemplateId": {
"type": "integer",
"description": "Notification template id",
"format": "int32"
},
"recipients": {
"type": "array",
"description": "The recipients email addresses",
"items": {
"type": "string"
}
}
},
"description": "This is the OrderNotifyCmd UE output pojo"
},
"PaymentCreditCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"InventoryAvailabilityIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/InventoryAvailabilityExternalIdentifier"
}
}
},
"OrderItemStatus": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"inventoryStatus": {
"type": "string"
},
"fulfillmentStatus": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"EmailAddress": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"VerifyPaymentAccountCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"protocolData": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"TaxIntegrationCustomCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"taxOrderItems": {
"type": "array",
"description": "taxOrderItem pojo list",
"items": {
"$ref": "#/components/schemas/TaxIntegrationCustomOrderItem"
}
},
"totalTax": {
"type": "number",
"description": "The total tax of the order"
},
"totalRecyclingFee": {
"type": "number",
"description": "The total recycling fee of the order"
}
},
"description": "This is the TaxIntegrationCustomCmd UE input pojo"
},
"RewardOption": {
"type": "object",
"properties": {
"rewardOptionIdentifier": {
"$ref": "#/components/schemas/RewardOptionIdentifier"
},
"adjustment": {
"$ref": "#/components/schemas/Adjustment"
},
"rewardChoice": {
"$ref": "#/components/schemas/RewardChoice"
},
"rewardSpecification": {
"$ref": "#/components/schemas/RewardSpecification"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"FetchPaymentTokenCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"protocolData": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"TaxIntegrationCustomOrderItem": {
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"description": "The order item ID",
"format": "int64"
},
"catalogEntryId": {
"type": "integer",
"description": "The catalog entry ID",
"format": "int64"
},
"partNumber": {
"type": "string",
"description": "The part number"
},
"cost": {
"type": "number",
"description": "The total cost for this order item.If the order item is for 4 units at $10 each, then the total cost would be $40."
},
"discount": {
"type": "number",
"description": "The total value of all non-tax-exempt discounts for this line item."
},
"jurisdictionCodes": {
"type": "array",
"description": "Obtains all the jurisdiction levels (codes) where the taxes are being calculated.Accepted types can be 'COUNTRY', 'TERRITORY', 'STATE', 'COUNTY', 'CITY' and 'DISTRICT'and the paramter should be set as this sequence:[COUNTRY,TERRITORY,STATE,COUNTY,CITY,DISTRICT] in array",
"items": {
"type": "string"
}
},
"secondaryJurisdictionCodes": {
"type": "array",
"description": "Obtains all the secondary jurisdiction levels (secondary codes) where the taxes are being calculated.Accepted types can be 'SECONDARYSTATE', 'SECONARYCOUNTY', 'SECONDARYCITY' and the paramter should be set as this sequence:[SECSTATE,SECCOUNTY,SECCITY] in array",
"items": {
"type": "string"
}
},
"secondaryTaxAmounts": {
"type": "array",
"description": "Obtains the tax amounts calculated for each of the given secondary jurisdiction levels returned from the tax calculation modules.Accepted types can be 'SECONDARYSTATE', 'SECONARYCOUNTY', 'SECONDARYCITY' and the paramter should be set as this sequence:[SECONDARYSTATE, SECONARYCOUNTY, SECONDARYCITY] in array",
"items": {
"type": "number"
}
},
"taxAmounts": {
"type": "array",
"description": "Obtains the tax amounts calculated for each of the given jurisdiction levels returned from the tax calculation modules.Accepted types can be 'COUNTRY', 'TERRITORY', 'STATE', 'COUNTY', 'CITY' and 'DISTRICT'and the paramter should be set as this sequence:[COUNTRY,TERRITORY,STATE,COUNTY,CITY,DISTRICT] in array",
"items": {
"type": "number"
}
},
"taxTypes": {
"type": "array",
"description": "Obtains all the taxing authority or jurisdiction levels where the taxes calculated.",
"items": {
"type": "integer",
"format": "int32"
}
},
"totalTax": {
"type": "number",
"description": "Obtains the total tax calculated for this order item for all relevant taxing authorities."
},
"auditFlag": {
"type": "boolean",
"description": "Turns on or off the audit (logging) of tax calculations for this order item.This is usually turned on only for the actual purchase and left off for all other calculations. It is false by default.",
"default": false
},
"businessName": {
"type": "string",
"description": "The name of the particular business location whichsells the order item. In WCS we set this to the same value as the sellerId"
},
"buyerName": {
"type": "string",
"description": "The name of the purchaser for this item.This field is typically used to determine if the purchaser has a tax exempt status or any other pertanent information."
},
"currencyCode": {
"type": "string",
"description": "This 3-character ISO currency code identifies the currency in which the transaction is being made."
},
"freight": {
"type": "number",
"description": "The total sbipping charge for this order item."
},
"invoiceNumber": {
"type": "string",
"description": "A unique string representing the Sales invoice.This method provides the ability to attach an identifier to the order itemIt is not used in the actual tax calculation. It is typically used to track orders between systems."
},
"itemCnt": {
"type": "number",
"description": "The number of units of this order item being purchased.",
"format": "double"
},
"sellerID": {
"type": "string",
"description": "This method is used to set the seller identification.For WCS this is the Store Identifier.This is assigned when the store is initially created and cannot be changed."
},
"sellerRegistrationId": {
"type": "string",
"description": "This is A seller registration identifier.This value is needed for international taxation."
},
"shipFromAddress": {
"type": "string",
"description": "The street address from which the order item will be shipped.This is either the address of the store or the fulfillment center address."
},
"shipFromCity": {
"type": "string",
"description": "The city portion of the address from which the order item will be shipped.This is either the address of the store or the fulfillment center address."
},
"shipFromCountry": {
"type": "string",
"description": "The country from which the order item will be shipped.This is from either the address of the store or the fulfillment center address."
},
"shipFromState": {
"type": "string",
"description": "The state portion of the address from which the order item will be shipped.This is either the address of the store or the fulfillment center address."
},
"shipFromTaxGeoCode": {
"type": "string",
"description": "The tax jurisdiction code (geoCode) from which the order item will be shipped.This is either the address of the store or the fulfillment center address."
},
"shipFromZip": {
"type": "string",
"description": "The zip code or postal code of the address from which the order item will be shipped.This is either theaddress of the store or the fulfillment center address."
},
"shipToAddress": {
"type": "string",
"description": "The street address to which the order item will be shipped. "
},
"shipToCity": {
"type": "string",
"description": "The city portion of the address to which the order item will be shipped. "
},
"shipToCountry": {
"type": "string",
"description": "The country to which the order item will be shipped."
},
"shipToState": {
"type": "string",
"description": "The state portion of the address to which the order item will be shipped."
},
"shipToTaxGeoCode": {
"type": "string",
"description": "The tax jurisdiction code (geoCode) to which the order item will be shipped."
},
"shipToZip": {
"type": "string",
"description": "The zip code or postal code of the address to which the order item will be shipped."
},
"storeId": {
"type": "integer",
"description": "The id of the input store to be used for determining the tax types.",
"format": "int32"
},
"taxCode": {
"type": "string",
"description": "the tax treatment code for this order item.In HCL Commerce Suite this maps to the tax calculation code.This is usually associated with a group of products that are taxed the same. i.e. groceries, clothing, automobiles, etc."
},
"transactionType": {
"type": "string",
"description": "The type of transaction.The default type is a Sale.valid values are 'B' - Backout a previous sale,'C' - Credit,'P' - Purchase,'R' - Return,'S' - Sale"
},
"timeShipped": {
"type": "string",
"description": "The time and date the order item shipped. ",
"format": "date-time"
},
"taxRate": {
"type": "array",
"description": "Obtains the tax rate for a given type of jurisdiction level.Accepted types can be 'COUNTRY', 'TERRITORY', 'STATE', 'COUNTY', 'CITY' and 'DISTRICT'and the paramter should be set as this sequence:[COUNTRY,TERRITORY,STATE,COUNTY,CITY,DISTRICT] in array",
"items": {
"type": "number"
}
},
"totalTaxRate": {
"type": "number",
"description": "Obtains the total tax rate for this order item for all relevant taxing authorities."
},
"secondaryTaxRate": {
"type": "array",
"description": "Obtains the tax rate for a given type of secondary jurisdiction level.Accepted types can be 'SECONDARYSTATE', 'SECONARYCOUNTY', 'SECONDARYCITY' and the paramter should be set as this sequence:[SECSTATE,SECCOUNTY,SECCITY] in array",
"items": {
"type": "number"
}
},
"recyclingFee": {
"type": "number",
"description": "Obtains the recycling fee for this order item."
},
"salesTaxTotal": {
"type": "number",
"description": "The sales tax total"
},
"shippingTaxTotal": {
"type": "number",
"description": "The shipping tax total"
}
},
"description": "This is the TaxIntegrationCustomOrderItem pojo which is part of TaxIntegrationCustomCmd UE input/ouput."
},
"PaymentApproveCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"PaymentDepositCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"BusinessProfile": {
"type": "object",
"properties": {
"employeeID": {
"type": "string"
},
"employeeType": {
"type": "string"
},
"departmentNumber": {
"type": "string"
},
"manager": {
"type": "string"
},
"secretary": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PaymentInformation": {
"type": "object",
"properties": {
"usableBillingAddress": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactInfoIdentifier"
}
},
"paymentMethod": {
"$ref": "#/components/schemas/PaymentMethod"
},
"paymentTermConditionId": {
"type": "string"
},
"protocolData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProtocolData"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PaymentReverseApprovalCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"ExtendAttribute": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
},
"attributeType": {
"type": "string"
}
}
},
"Person": {
"type": "object",
"properties": {
"personIdentifier": {
"$ref": "#/components/schemas/PersonIdentifier"
},
"parentOrganizationIdentifier": {
"$ref": "#/components/schemas/OrganizationIdentifier"
},
"credential": {
"$ref": "#/components/schemas/Credential"
},
"personalProfile": {
"$ref": "#/components/schemas/PersonalProfile"
},
"businessProfile": {
"$ref": "#/components/schemas/BusinessProfile"
},
"contactInfo": {
"$ref": "#/components/schemas/ContactInfo"
},
"addressBook": {
"$ref": "#/components/schemas/AddressBook"
},
"contextAttribute": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Attribute"
}
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"checkoutProfile": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckoutProfile"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"registrationStatus": {
"type": "string"
},
"registrationApprovalStatus": {
"type": "string"
},
"passwordExpired": {
"type": "boolean",
"default": false
},
"accountStatus": {
"type": "string"
},
"profile": {
"type": "string",
"enum": [
"CONSUMER",
"BUSINESS"
]
}
}
},
"OrderShippingInfo": {
"type": "object",
"properties": {
"shippingAddress": {
"$ref": "#/components/schemas/ContactInfo"
},
"shippingMode": {
"$ref": "#/components/schemas/ShippingMode"
},
"requestedShipDate": {
"type": "string",
"format": "date-time"
},
"physicalStoreIdentifier": {
"$ref": "#/components/schemas/PhysicalStoreIdentifier"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"OrderCustomJobUERequest": {
"type": "object",
"properties": {
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
},
"CreatePaymentTokenCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"protocolData": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"Description": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"language": {
"type": "string"
}
}
},
"RewardOptionIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"type": "string"
}
}
},
"ShippingModeIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/ExternalShipModeIdentifier"
}
}
},
"Attribute": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributeValue": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttributeValue"
}
}
}
},
"OrderPostUEResponse": {
"type": "object",
"properties": {
"commandOutputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"order": {
"$ref": "#/components/schemas/Order"
}
},
"description": "This is the post UE response for the order controller commands"
},
"GenericTotal": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"currency": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"GetPunchoutURLCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"punchoutURL": {
"type": "string",
"description": "payment authentication url"
},
"paymentInstruction": {
"$ref": "#/components/schemas/PaymentInstruction"
}
},
"description": "This is the GetPunchoutURLCmd UE output pojo"
},
"PersonPreUEResponse": {
"type": "object",
"properties": {
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"person": {
"$ref": "#/components/schemas/Person"
}
},
"description": "This is the pre UE response for the user registration controller commands"
},
"ExtOrderProcessCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"orderRn": {
"type": "integer",
"description": "The order reference number",
"format": "int64"
}
},
"description": "This is the ExtOrderProcessCmd UE output pojo"
},
"ScheduleEndInfo": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"format": "date-time"
},
"duration": {
"$ref": "#/components/schemas/Quantity"
},
"totalOccurrences": {
"type": "integer"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ScheduleStartInfo": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"format": "date-time"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"OrderReplaceUEResponse": {
"type": "object",
"properties": {
"commandOutputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"order": {
"$ref": "#/components/schemas/Order"
}
},
"description": "This is the replace UE response for the order controller commands"
},
"OrderItemCharges": {
"type": "object",
"properties": {
"unitPrice": {
"$ref": "#/components/schemas/UnitPrice"
},
"orderItemPrice": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"totalAdjustment": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"adjustment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Adjustment"
}
},
"genericTotal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericTotal"
}
},
"shippingCharge": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"salesTax": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"shippingTax": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"taxByTaxCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxByTaxCategory"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"priceOverride": {
"type": "boolean",
"default": false
},
"freeGift": {
"type": "boolean",
"default": false
},
"isPriceForInformationOnly": {
"type": "boolean",
"default": false
}
}
},
"OrderStatus": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"buyerApprovalStatus": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"prepareIndicator": {
"type": "boolean",
"default": false
},
"editable": {
"type": "boolean",
"default": false
},
"locked": {
"type": "boolean",
"default": false
},
"blocked": {
"type": "boolean",
"default": false
}
}
},
"OrderNotificationInfo": {
"type": "object",
"properties": {
"sms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MobilePhone"
}
},
"allEMailsRecipient": {
"$ref": "#/components/schemas/EmailAddress"
},
"orderReceivedEMailRecipient": {
"$ref": "#/components/schemas/EmailAddress"
},
"orderCancelEMailRecipient": {
"$ref": "#/components/schemas/EmailAddress"
},
"orderCancelForMerchantEMailRecipient": {
"$ref": "#/components/schemas/EmailAddress"
},
"orderChangedEMailRecipient": {
"$ref": "#/components/schemas/EmailAddress"
},
"releaseShipNotifyEMailRecipient": {
"$ref": "#/components/schemas/EmailAddress"
},
"merchantNotify": {
"type": "string"
},
"shopperNotify": {
"type": "string"
},
"orderSubmittedNotify": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"email": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAddress"
}
}
}
},
"UEInvocation": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"responseId": {
"type": "string"
},
"compensationResult": {
"type": "string"
},
"uename": {
"type": "string"
}
}
},
"FetchPaymentTokenCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"paymentToken": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"IncomeAmount": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32"
},
"currency": {
"type": "string"
}
}
},
"GetPunchoutURLCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"paymentInstruction": {
"$ref": "#/components/schemas/PaymentInstruction"
},
"order": {
"$ref": "#/components/schemas/Order"
}
},
"description": "This is the GetPunchoutURLCmd UE input pojo"
},
"CalculationCodeExternalIdentifier": {
"type": "object",
"properties": {
"calculationUsageID": {
"type": "string"
},
"code": {
"type": "string"
},
"storeIdentifier": {
"$ref": "#/components/schemas/StoreIdentifier"
}
}
},
"OrderPostUERequest": {
"type": "object",
"properties": {
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"commandOutputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"PhysicalStoreIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"type": "string"
}
}
},
"GiftListIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"giftListExternalIdentifier": {
"$ref": "#/components/schemas/GiftListExternalIdentifier"
}
}
},
"ReceiveEmailPreference": {
"type": "object",
"properties": {
"value": {
"type": "boolean",
"default": false
},
"storeID": {
"type": "string"
}
}
},
"InventoryAvailabilityExternalIdentifier": {
"type": "object",
"properties": {
"catalogEntryIdentifier": {
"$ref": "#/components/schemas/CatalogEntryIdentifier"
},
"onlineStoreIdentifier": {
"$ref": "#/components/schemas/StoreIdentifier"
},
"physicalStoreIdentifier": {
"$ref": "#/components/schemas/PhysicalStoreIdentifier"
}
}
},
"Credential": {
"type": "object",
"properties": {
"logonID": {
"type": "string"
},
"password": {
"type": "string"
},
"securityHint": {
"$ref": "#/components/schemas/SecurityHint"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"OrderNotifyCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"notificationEnabled": {
"type": "boolean",
"description": "Enable or disable order notification",
"default": false
},
"notificationTemplateId": {
"type": "integer",
"description": "Notification template id",
"format": "int32"
},
"recipients": {
"type": "array",
"description": "The recipients email addresses",
"items": {
"type": "string"
}
}
},
"description": "This is the OrderNotifyCmd UE input pojo"
},
"ProcessPunchoutResponseCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"paymentInstruction": {
"$ref": "#/components/schemas/PaymentInstruction"
},
"callBackParams": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
},
"description": "call back parameters"
}
},
"description": "This is the ProcessPunchoutResponseCmd UE input pojo"
},
"StoreIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/StoreExternalIdentifier"
}
}
},
"SessionCleanCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"paymentInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInstruction"
}
}
}
},
"PaymentReverseDepositCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"StoreExternalIdentifier": {
"type": "object",
"properties": {
"nameIdentifier": {
"type": "string"
},
"ownerID": {
"type": "string"
}
}
},
"PersonPreUERequest": {
"type": "object",
"properties": {
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"person": {
"$ref": "#/components/schemas/Person"
}
}
},
"PromotionIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/PromotionExternalIdentifier"
},
"calculationCodeIdentifier": {
"$ref": "#/components/schemas/CalculationCodeIdentifier"
}
}
},
"UnitPrice": {
"type": "object",
"properties": {
"price": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"alternativeCurrencyPrice": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryAmount"
}
},
"quantity": {
"$ref": "#/components/schemas/Quantity"
}
}
},
"CouponCode": {
"type": "object",
"properties": {
"couponId": {
"type": "string"
},
"code": {
"type": "string"
},
"promotionIdentifier": {
"$ref": "#/components/schemas/PromotionIdentifier"
},
"description": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CouponDescription"
}
},
"effectiveDateTime": {
"type": "string",
"format": "date-time"
},
"expirationDateTime": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"CreatePaymentTokenCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"paymentToken": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"FulfillmentCenterInventoryAvailability": {
"type": "object",
"properties": {
"fulfillmentCenterIdentifier": {
"$ref": "#/components/schemas/FulfillmentCenterIdentifier"
},
"availableQuantity": {
"$ref": "#/components/schemas/Quantity"
},
"expectedInventory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpectedInventory"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"RemovePaymentTokenCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"protocolData": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"ChangeReasonCode": {
"type": "object",
"properties": {
"reasonCode": {
"type": "string"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PromotionExternalIdentifier": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"storeIdentifier": {
"$ref": "#/components/schemas/StoreIdentifier"
},
"version": {
"type": "integer"
},
"revision": {
"type": "integer"
}
}
},
"PaymentCreditCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"OrderItem": {
"type": "object",
"properties": {
"orderItemIdentifier": {
"$ref": "#/components/schemas/OrderItemIdentifier"
},
"catalogEntryIdentifier": {
"$ref": "#/components/schemas/CatalogEntryIdentifier"
},
"itemAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"orderItemComponent": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItemComponent"
}
},
"quantity": {
"$ref": "#/components/schemas/Quantity"
},
"configurationID": {
"type": "string"
},
"orderItemConfiguration": {
"type": "string"
},
"contractIdentifier": {
"$ref": "#/components/schemas/ContractIdentifier"
},
"offerID": {
"type": "string"
},
"adjustmentRequirement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentRequirement"
}
},
"orderItemAmount": {
"$ref": "#/components/schemas/OrderItemCharges"
},
"usableShippingAddress": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactInfoIdentifier"
}
},
"usableShippingMode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingMode"
}
},
"orderItemShippingInfo": {
"$ref": "#/components/schemas/OrderItemShippingInfo"
},
"orderItemStatus": {
"$ref": "#/components/schemas/OrderItemStatus"
},
"orderItemFulfillmentInfo": {
"$ref": "#/components/schemas/OrderItemFulfillmentInfo"
},
"fulfillmentCenter": {
"$ref": "#/components/schemas/FulfillmentCenter"
},
"correlationGroup": {
"type": "string"
},
"orderItemDescription": {
"type": "string"
},
"comments": {
"type": "string"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"lastUpdateDate": {
"type": "string",
"format": "date-time"
},
"usableShippingChargePolicy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyIdentifier"
}
},
"giftItemInfo": {
"$ref": "#/components/schemas/GiftItemInfo"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"orderItemExtendAttribute": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtendAttribute"
}
}
}
},
"OrderPaymentInfo": {
"type": "object",
"properties": {
"paymentInstruction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInstruction"
}
},
"status": {
"type": "string"
},
"financialTransaction": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialTransaction"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"RewardChoice": {
"type": "object",
"properties": {
"giftSet": {
"$ref": "#/components/schemas/GiftSet"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ContractIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/ContractExternalIdentifier"
}
}
},
"ProcessOrderCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"requestProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"responseProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"orderRn": {
"type": "integer",
"format": "int64"
},
"billToRn": {
"type": "integer",
"format": "int64"
},
"notifyMerchant": {
"type": "integer",
"format": "int32"
},
"notifyShopper": {
"type": "integer",
"format": "int32"
},
"quotationSubmission": {
"type": "string"
},
"quoteExpiredURL": {
"type": "string"
},
"quoteExpiryPolicy": {
"type": "string"
},
"maxAvailabilityChange": {
"type": "integer",
"format": "int64"
},
"availabilityChangeURL": {
"type": "string"
},
"noInventoryURL": {
"type": "string"
},
"notifyOrderSubmitted": {
"type": "integer",
"format": "int32"
},
"transferMode": {
"type": "string"
},
"poNumber": {
"type": "string"
},
"reduceParentQuantities": {
"type": "string"
},
"externalUserId": {
"type": "string"
},
"externalPassword": {
"type": "string"
},
"notificationAttributes": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"CSRComments": {
"type": "object",
"properties": {
"creationDate": {
"type": "string",
"format": "date-time"
},
"comment": {
"type": "string"
},
"changeReasonCode": {
"$ref": "#/components/schemas/ChangeReasonCode"
},
"orderVersion": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"csridentifier": {
"$ref": "#/components/schemas/PersonIdentifier"
}
}
},
"OrderItemIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalOrderItemID": {
"type": "string"
}
}
},
"Locale": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"script": {
"type": "string"
},
"country": {
"type": "string"
},
"variant": {
"type": "string"
},
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"iso3Language": {
"type": "string"
},
"iso3Country": {
"type": "string"
},
"displayLanguage": {
"type": "string"
},
"displayScript": {
"type": "string"
},
"displayCountry": {
"type": "string"
},
"displayVariant": {
"type": "string"
},
"displayName": {
"type": "string"
}
}
},
"PaymentReverseDepositCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"AttributeValue": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"type": "string"
}
},
"storeID": {
"type": "string"
}
}
},
"BlockReason": {
"type": "object",
"properties": {
"reasonCode": {
"type": "string"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"reansonType": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"OrderIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalOrderID": {
"type": "string"
},
"customerOrderNumber": {
"type": "string"
}
}
},
"PreProcessOrderCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"requestProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"responseProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"orderRn": {
"type": "integer",
"description": "The order reference number",
"format": "int64"
},
"billToRn": {
"type": "integer",
"description": "The reference number of the address to bill",
"format": "int64"
},
"notifyMerchant": {
"type": "integer",
"description": "Whether to notify the merchant when the order has been processed",
"format": "int32"
},
"notifyShopper": {
"type": "integer",
"description": "Whether to notify the shopper when the order has been processed",
"format": "int32"
},
"quotationSubmission": {
"type": "string",
"description": "QuotationSubmission parameter"
},
"quoteExpiredURL": {
"type": "string",
"description": "The URL to redirect to if the order total expired in agreement with the expiry policy set by the setQuoteExpiryPolicy method"
},
"quoteExpiryPolicy": {
"type": "string",
"description": "The behavior of the command if the order total expires or an order item's fulfillment center changes during inventory allocation"
},
"maxAvailabilityChange": {
"type": "integer",
"description": "The time interval, in seconds, used with the url set by the setAvailabilityChangeURL method",
"format": "int64"
},
"availabilityChangeURL": {
"type": "string",
"description": "The URL to redirect to"
},
"noInventoryURL": {
"type": "string",
"description": "The URL to redirect to if any of the order items in the order cannot be allocated or backordered"
},
"notifyOrderSubmitted": {
"type": "integer",
"description": "Whether the customer should be notified when the order is successfully submitted",
"format": "int32"
},
"transferMode": {
"type": "string",
"description": "The transferMode property of the command"
},
"poNumber": {
"type": "string",
"description": "PO number"
}
},
"description": "This is the PreProcessOrderCmd UE input pojo"
},
"QuoteIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalQuoteID": {
"type": "string"
}
}
},
"PromotionCodeReason": {
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"default": false
},
"reasonCode": {
"type": "string"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ChangeInventoryAvailabilityBasePartExtCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"noun": {
"$ref": "#/components/schemas/InventoryAvailability"
},
"oldNoun": {
"$ref": "#/components/schemas/InventoryAvailability"
}
}
},
"SubscriptionInfo": {
"type": "object",
"properties": {
"paymentInfo": {
"$ref": "#/components/schemas/SubscriptionPaymentInfo"
},
"fulfillmentSchedule": {
"$ref": "#/components/schemas/ScheduleInfo"
},
"paymentSchedule": {
"$ref": "#/components/schemas/ScheduleInfo"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ProcessOrderSubmitEventCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"requestProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"responseProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"orderId": {
"type": "integer",
"format": "int64"
}
}
},
"PersonalProfile": {
"type": "object",
"properties": {
"preferredCurrency": {
"type": "string"
},
"preferredLanguage": {
"type": "string"
},
"displayName": {
"type": "string"
},
"description": {
"type": "string"
},
"photoURI": {
"type": "string"
},
"preferredCommunication": {
"type": "string"
},
"preferredDelivery": {
"type": "string"
},
"receiveSMSNotification": {
"type": "boolean",
"default": false
},
"receiveEmailPreference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiveEmailPreference"
}
},
"receiveSMSPreference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceiveSMSPreference"
}
},
"gender": {
"type": "string"
},
"income": {
"$ref": "#/components/schemas/IncomeAmount"
},
"maritalStatus": {
"type": "string"
},
"numberOfChildren": {
"type": "integer",
"format": "int32"
},
"householdSize": {
"type": "integer",
"format": "int32"
},
"companyName": {
"type": "string"
},
"hobbies": {
"type": "string"
},
"dateOfBirth": {
"type": "string",
"format": "date-time"
},
"registrationDateTime": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"GiftItemInfo": {
"type": "object",
"properties": {
"giftListIdentifier": {
"$ref": "#/components/schemas/GiftListIdentifier"
},
"giftMessage": {
"type": "string"
},
"shipToRegistrant": {
"type": "boolean",
"default": false
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"MobilePhone": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"country": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PersonReplaceUEResponse": {
"type": "object",
"properties": {
"commandOutputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"person": {
"$ref": "#/components/schemas/Person"
}
},
"description": "This is the replace UE response for the user registration controller commands"
},
"OrderMessagingCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"orderRn": {
"type": "integer",
"description": "The order reference number",
"format": "int64"
}
},
"description": "This is the OrderMessagingCmd UE output pojo"
},
"PersonIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"distinguishedName": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/PersonExternalIdentifier"
}
}
},
"AddressBook": {
"type": "object",
"properties": {
"contact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactInfo"
}
}
}
},
"ChangeInventoryAvailabilityBasePartExtCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"noun": {
"$ref": "#/components/schemas/InventoryAvailability"
}
}
},
"ProcessOrderCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"requestProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"responseProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"orderRn": {
"type": "integer",
"format": "int64"
},
"billToRn": {
"type": "integer",
"format": "int64"
},
"notifyMerchant": {
"type": "integer",
"format": "int32"
},
"notifyShopper": {
"type": "integer",
"format": "int32"
},
"quotationSubmission": {
"type": "string"
},
"quoteExpiredURL": {
"type": "string"
},
"quoteExpiryPolicy": {
"type": "string"
},
"maxAvailabilityChange": {
"type": "integer",
"format": "int64"
},
"availabilityChangeURL": {
"type": "string"
},
"noInventoryURL": {
"type": "string"
},
"notifyOrderSubmitted": {
"type": "integer",
"format": "int32"
},
"transferMode": {
"type": "string"
},
"poNumber": {
"type": "string"
},
"reduceParentQuantities": {
"type": "string"
},
"externalUserId": {
"type": "string"
},
"externalPassword": {
"type": "string"
},
"notificationAttributes": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"ProcessPunchoutResponseCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"responseParams": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
},
"description": "Response parameters"
},
"paymentInstruction": {
"$ref": "#/components/schemas/PaymentInstruction"
}
},
"description": "This is the ProcessPunchoutResponseCmd UE output pojo"
},
"ContextData": {
"type": "object",
"properties": {
"baseContext": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"accessControlContext": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"locale": {
"$ref": "#/components/schemas/Locale"
}
}
},
"ShippingMode": {
"type": "object",
"properties": {
"shippingModeIdentifier": {
"$ref": "#/components/schemas/ShippingModeIdentifier"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"trackingURL": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ContactInfoIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/ContactInfoExternalIdentifier"
}
}
},
"ShippingInfo": {
"type": "object",
"properties": {
"shippingAddress": {
"$ref": "#/components/schemas/ContactInfo"
},
"shippingMode": {
"$ref": "#/components/schemas/ShippingMode"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"CatalogEntryIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/PartNumberIdentifier"
}
}
},
"ExtraAdjustment": {
"type": "object",
"properties": {
"calculationCodeIdentifier": {
"$ref": "#/components/schemas/CalculationCodeIdentifier"
},
"isOverrideExistingAdjustments": {
"type": "boolean",
"default": false
},
"adjustmentApplyPolicy": {
"type": "string"
},
"adjustmentApplyAmount": {
"type": "string"
},
"orderItemIdentifier": {
"$ref": "#/components/schemas/OrderItemIdentifier"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PersonPostUERequest": {
"type": "object",
"properties": {
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"commandOutputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"person": {
"$ref": "#/components/schemas/Person"
}
}
},
"Order": {
"type": "object",
"properties": {
"orderIdentifier": {
"$ref": "#/components/schemas/OrderIdentifier"
},
"storeIdentifier": {
"$ref": "#/components/schemas/StoreIdentifier"
},
"channel": {
"$ref": "#/components/schemas/Channel"
},
"quoteID": {
"type": "string"
},
"quoteIdentifier": {
"$ref": "#/components/schemas/QuoteIdentifier"
},
"buyerPONumber": {
"type": "string"
},
"organizationIdentifier": {
"$ref": "#/components/schemas/OrganizationIdentifier"
},
"buyerIdentifier": {
"$ref": "#/components/schemas/PersonIdentifier"
},
"buyerBillInfo": {
"$ref": "#/components/schemas/ContactInfo"
},
"couponCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CouponCode"
}
},
"promotionCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromotionCode"
}
},
"rewardOption": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RewardOption"
}
},
"adjustmentRequirement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentRequirement"
}
},
"orderAmount": {
"$ref": "#/components/schemas/OrderCharges"
},
"usableShippingAddress": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactInfoIdentifier"
}
},
"orderPaymentInfo": {
"$ref": "#/components/schemas/OrderPaymentInfo"
},
"usablePaymentInformation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInformation"
}
},
"usableShippingMode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingMode"
}
},
"orderStatus": {
"$ref": "#/components/schemas/OrderStatus"
},
"orderEditor": {
"$ref": "#/components/schemas/PersonIdentifier"
},
"orderDescription": {
"type": "string"
},
"comments": {
"type": "string"
},
"lastUpdateDate": {
"type": "string",
"format": "date-time"
},
"placedDate": {
"type": "string",
"format": "date-time"
},
"orderItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
}
},
"orderNotificationInfo": {
"$ref": "#/components/schemas/OrderNotificationInfo"
},
"orderShippingInfo": {
"$ref": "#/components/schemas/OrderShippingInfo"
},
"orderScheduleInfo": {
"$ref": "#/components/schemas/OrderScheduleInfo"
},
"orderGiftInfo": {
"$ref": "#/components/schemas/GiftItemInfo"
},
"parentInfo": {
"$ref": "#/components/schemas/ParentInfo"
},
"subscriptionInfo": {
"$ref": "#/components/schemas/SubscriptionInfo"
},
"calculationInfo": {
"$ref": "#/components/schemas/CalculationInfo"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"orderExtendAttribute": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtendAttribute"
}
},
"orderVersion": {
"type": "string"
},
"shipAsComplete": {
"type": "boolean",
"default": false
},
"blockInfo": {
"$ref": "#/components/schemas/OrderBLockInfo"
},
"csrcomments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CSRComments"
}
},
"orderCode": {
"type": "string"
}
}
},
"TaxByTaxCategory": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"currency": {
"type": "string"
},
"taxCategoryCode": {
"type": "string"
}
}
},
"PaymentApproveCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"Channel": {
"type": "object",
"properties": {
"channelIdentifer": {
"$ref": "#/components/schemas/ChannelIdentifer"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"PersonExternalIdentifier": {
"type": "object",
"properties": {
"identifier": {
"type": "string"
}
}
},
"PartNumberIdentifier": {
"type": "object",
"properties": {
"partNumber": {
"type": "string"
},
"storeIdentifier": {
"$ref": "#/components/schemas/StoreIdentifier"
},
"ownerID": {
"type": "string"
}
}
},
"OrganizationIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"distinguishedName": {
"type": "string"
}
}
},
"ParentInfo": {
"type": "object",
"properties": {
"parentOrderIdentifier": {
"$ref": "#/components/schemas/OrderIdentifier"
},
"parentOrderItemIdentifier": {
"$ref": "#/components/schemas/OrderItemIdentifier"
},
"relationTypeCode": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"InventoryAvailability": {
"type": "object",
"properties": {
"inventoryAvailabilityIdentifier": {
"$ref": "#/components/schemas/InventoryAvailabilityIdentifier"
},
"inventoryStatus": {
"type": "string"
},
"availableQuantity": {
"$ref": "#/components/schemas/Quantity"
},
"availabilityDateTime": {
"type": "string",
"format": "date-time"
},
"availabilityOffset": {
"type": "integer"
},
"lastUpdateDateTime": {
"type": "string",
"format": "date-time"
},
"fulfillmentCenterInventoryAvailability": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentCenterInventoryAvailability"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ContractExternalIdentifier": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"origin": {
"type": "string"
},
"majorVersionNumber": {
"type": "integer",
"format": "int32"
},
"minorVersionNumber": {
"type": "integer",
"format": "int32"
},
"ownerID": {
"type": "string"
}
}
},
"OrderReplaceUERequest": {
"type": "object",
"properties": {
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"Payment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "integer",
"format": "int32"
},
"targetAmount": {
"type": "number"
},
"approvedAmount": {
"type": "number"
},
"approvingAmount": {
"type": "number"
},
"depositingAmount": {
"type": "number"
},
"depositedAmount": {
"type": "number"
},
"reversingApprovedAmount": {
"type": "number"
},
"reversingDepositedAmount": {
"type": "number"
},
"avsCode": {
"type": "integer",
"format": "int32"
},
"attentionRequired": {
"type": "boolean",
"default": false
},
"paymentInstruction": {
"$ref": "#/components/schemas/PaymentInstruction"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"depositTransactions": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"reverseApprovalTransactions": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"reverseDepositTransactions": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"approveTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
},
"expired": {
"type": "boolean",
"default": false
}
}
},
"OrderBlock": {
"type": "object",
"properties": {
"comments": {
"type": "string"
},
"timeBlocked": {
"type": "string",
"format": "date-time"
},
"blockReason": {
"$ref": "#/components/schemas/BlockReason"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"resovled": {
"type": "boolean",
"default": false
}
}
},
"UpdatePaymentTokenCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"paymentToken": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"PolicyIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"externalIdentifier": {
"$ref": "#/components/schemas/PolicyExternalIdentifier"
}
}
},
"PaymentMethod": {
"type": "object",
"properties": {
"paymentMethodName": {
"type": "string"
},
"description": {
"$ref": "#/components/schemas/Description"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"OrderMessagingCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"orderRn": {
"type": "integer",
"description": "The order reference number",
"format": "int64"
}
},
"description": "This is the OrderMessagingCmd UE input pojo"
},
"SubscriptionPaymentInfo": {
"type": "object",
"properties": {
"amountToCharge": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"totalCost": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"amountPaid": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"CalculationCodeIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"calculationCodeExternalIdentifier": {
"$ref": "#/components/schemas/CalculationCodeExternalIdentifier"
}
}
},
"ExternalShipModeIdentifier": {
"type": "object",
"properties": {
"storeUniqueID": {
"type": "string"
},
"shipModeCode": {
"type": "string"
},
"carrier": {
"type": "string"
}
}
},
"Telephone": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"type": {
"type": "string"
},
"publish": {
"type": "boolean",
"default": false
}
}
},
"UserData": {
"type": "object",
"properties": {
"userDataField": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"ReceiveSMSPreference": {
"type": "object",
"properties": {
"value": {
"type": "boolean",
"default": false
},
"storeID": {
"type": "string"
}
}
},
"SessionCleanCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"paymentInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentInstruction"
}
}
}
},
"PaymentApproveAndDepositCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"financialTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
}
}
},
"PaymentInstruction": {
"type": "object",
"properties": {
"extendedData": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"account": {
"type": "string"
},
"currency": {
"type": "string"
},
"id": {
"type": "string"
},
"amount": {
"type": "number"
},
"state": {
"type": "integer",
"format": "int32"
},
"orderId": {
"type": "string"
},
"rmaId": {
"type": "string"
},
"store": {
"type": "string"
},
"paymentSystemName": {
"type": "string"
},
"timeCreated": {
"type": "integer",
"format": "int64"
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
}
},
"credits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Credit"
}
},
"approvingAmount": {
"type": "number"
},
"approvedAmount": {
"type": "number"
},
"depositingAmount": {
"type": "number"
},
"depositedAmount": {
"type": "number"
},
"creditingAmount": {
"type": "number"
},
"creditedAmount": {
"type": "number"
},
"timeUpdate": {
"type": "integer",
"format": "int64"
}
}
},
"OrderItemComponent": {
"type": "object",
"properties": {
"orderItemComponentIdentifier": {
"$ref": "#/components/schemas/OrderItemComponentIdentifier"
},
"catalogEntryIdentifier": {
"$ref": "#/components/schemas/CatalogEntryIdentifier"
},
"quantity": {
"$ref": "#/components/schemas/Quantity"
},
"unitPrice": {
"$ref": "#/components/schemas/UnitPrice"
},
"configurationID": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
},
"required": {
"type": "boolean",
"default": false
}
}
},
"OrderItemComponentIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
}
}
},
"OrderScheduleInfo": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"interval": {
"type": "integer",
"format": "int32"
}
}
},
"RewardSpecification": {
"type": "object",
"properties": {
"giftSetSpecification": {
"$ref": "#/components/schemas/GiftSetSpecification"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ExtOrderProcessCmdUEInput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"orderRn": {
"type": "integer",
"description": "The order reference number",
"format": "int64"
}
},
"description": "This is the ExtOrderProcessCmd UE Input pojo"
},
"PolicyExternalIdentifier": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"storeIdentifier": {
"$ref": "#/components/schemas/StoreIdentifier"
}
}
},
"TaxIntegrationCustomCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"taxOrderItems": {
"type": "array",
"description": "taxOrderItem pojo list",
"items": {
"$ref": "#/components/schemas/TaxIntegrationCustomOrderItem"
}
},
"totalTax": {
"type": "number",
"description": "The total tax of the order"
},
"totalRecyclingFee": {
"type": "number",
"description": "The total recycling fee of the order"
}
},
"description": "This is the TaxIntegrationCustomCmd UE output pojo"
},
"Credit": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "integer",
"format": "int32"
},
"paymentInstruction": {
"$ref": "#/components/schemas/PaymentInstruction"
},
"creditTransaction": {
"$ref": "#/components/schemas/FinancialTransaction"
},
"creditedAmount": {
"type": "number"
},
"creditingAmount": {
"type": "number"
},
"reversingAmount": {
"type": "number"
},
"targetAmount": {
"type": "number"
}
}
},
"OrderCharges": {
"type": "object",
"properties": {
"grandTotal": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"totalProductPrice": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"totalAdjustment": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"genericTotal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericTotal"
}
},
"adjustment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Adjustment"
}
},
"totalShippingCharge": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"totalSalesTax": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"totalShippingTax": {
"$ref": "#/components/schemas/MonetaryAmount"
},
"totalTaxByTaxCategory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxByTaxCategory"
}
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"GiftListExternalIdentifier": {
"type": "object",
"properties": {
"externalIdentifier": {
"type": "string"
},
"storeIdentifier": {
"$ref": "#/components/schemas/StoreIdentifier"
}
}
},
"ScheduleFrequencyInfo": {
"type": "object",
"properties": {
"frequency": {
"$ref": "#/components/schemas/Quantity"
},
"nextOccurence": {
"type": "string",
"format": "date-time"
},
"remainingOccurrences": {
"type": "integer"
},
"completedOccurrences": {
"type": "integer"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"RemovePaymentTokenCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"paymentToken": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"ExpectedInventory": {
"type": "object",
"properties": {
"availableQuantity": {
"$ref": "#/components/schemas/Quantity"
},
"availabilityDateTime": {
"type": "string",
"format": "date-time"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"ProtocolData": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"OrderPreUERequest": {
"type": "object",
"properties": {
"contextData": {
"$ref": "#/components/schemas/ContextData"
},
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"OrderPreUEResponse": {
"type": "object",
"properties": {
"commandInputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"order": {
"$ref": "#/components/schemas/Order"
}
},
"description": "This is the pre UE response for the order controller commands"
},
"PersonName": {
"type": "object",
"properties": {
"personTitle": {
"type": "string"
},
"businessTitle": {
"type": "string"
},
"lastName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
}
}
},
"ProcessOrderSubmitEventCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"order": {
"$ref": "#/components/schemas/Order"
},
"requestProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"responseProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"orderId": {
"type": "integer",
"format": "int64"
}
}
},
"VerifyPaymentAccountCmdUEOutput": {
"type": "object",
"properties": {
"commandStoreId": {
"type": "integer",
"format": "int32"
},
"defaultProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"userId": {
"type": "integer",
"format": "int64"
},
"verificationResult": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
},
"Quantity": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double"
},
"uom": {
"type": "string"
}
}
},
"PersonPostUEResponse": {
"type": "object",
"properties": {
"commandOutputs": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"person": {
"$ref": "#/components/schemas/Person"
}
},
"description": "This is the post UE response for the user registration controller commands"
},
"GiftSetSpecification": {
"type": "object",
"properties": {
"maximumQuantity": {
"$ref": "#/components/schemas/Quantity"
},
"giftItem": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GiftItem"
}
}
}
},
"SecurityHint": {
"type": "object",
"properties": {
"question": {
"type": "string"
},
"answer": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"GiftItem": {
"type": "object",
"properties": {
"catalogEntryIdentifier": {
"$ref": "#/components/schemas/CatalogEntryIdentifier"
},
"quantity": {
"$ref": "#/components/schemas/Quantity"
}
}
},
"FinancialTransaction": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "integer",
"format": "int32"
},
"trackingId": {
"type": "string"
},
"referenceNumber": {
"type": "string"
},
"responseCode": {
"type": "string"
},
"reasonCode": {
"type": "string"
},
"requestedAmount": {
"type": "number"
},
"processedAmount": {
"type": "number"
},
"timeCreated": {
"type": "string",
"format": "date-time"
},
"timeUpdated": {
"type": "string",
"format": "date-time"
},
"extendedData": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"transactionType": {
"type": "integer",
"format": "int32"
},
"payment": {
"$ref": "#/components/schemas/Payment"
},
"credit": {
"$ref": "#/components/schemas/Credit"
}
}
},
"Fax": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"userData": {
"$ref": "#/components/schemas/UserData"
}
}
},
"FulfillmentCenterIdentifier": {
"type": "object",
"properties": {
"uniqueID": {
"type": "string"
},
"name": {
"type": "string"
},
"ownerId": {
"type": "string"
}
}
}
}
}
}