| 1 | orderidlength | 14 | This attribute holds the length of the order ID to be generated. The possible values are from 14 to 25. |
| 2 | BPM_SubmitOrder | | This attribute holds a custom submit order BPM configuration. |
| 3 | lookupRequiredFields | usertracking.lastname,
usertracking.zip | This attribute holds the required fields for order lookup. |
| 4 | isNumericOrderIdOnly | false | This attribute is to set the format of the order ID. It is either numeric or alphanumeric. The possible values are true and false. |
| 5 | skipDefaultQueue | promotion.block/assign,payment.bulkTransactionRequestQueue,inventory.bulktransactions,account.budgettransaction,loyaltyListenerQueue,account.workflow | If this attribute has one or more queue names, then the default queue will be skipped for events.
Note: The queue account.budgettransaction is used for budget calculation in the Accounts microservice. |
| 6 | createOrderValidator | com.skava.oms.validator.services.order.CreateOrderFulfilmentTypeValidator,
com.skava.oms.validator.services.order.CreateOrderMathDuplicateTypeValidator,
com.skava.oms.validator.services.order.CreateOrderDiscountValidator,
com.skava.oms.validator.services.order.CreateOrderShippingValidator,
com.skava.oms.validator.services.order.CreateOrderGlobalDiscountValidator,
com.skava.oms.validator.services.order.OrderLevelTaxProrationValidator,
com.skava.oms.validator.services.order.CreateOrderItemPriceValidator,
com.skava.oms.validator.services.order.CreateOrderTotalMathValidator | Indicates a list of classes that contains the validations which validates the creation of an order. |
| 7 | createOrderCustomValidator | com.skava.oms.validator.services.order.CreateOrderCustomValidator | Indicates an external validator to validate the integrated services. |
| 8 | returnAddress | [{"addressLine1":"200 E MAIN ST","addressLine2":"SUITE 5A-1204","addressLine3":"PHOENIX","city":"COIMBATORE","companyname":"SKAVA","country":"INDIA","county":"Ferry", "deliveryinstruction":"string","firstName":"William", "lastName":"Pitt","middlename":"Bradley","state":"TN","type":"office","zipcode":76491,"ContactDetails":"phone\/email"}] | This attribute holds the address to which the product is returned. |
| 9 | orderConfigurations | [
{
"workflow": [
{
"orderType": {
"name": "Cancel",
"displayName": "Cancel"
},
"nextStatus": "Cancelled"
},
{
"orderType": {
"name": "editorder",
"displayName": "Edit Order"
},
"nextStatus": "Return_Submitted",
"allowedComponents": [
{
"name": "addsku",
"label": "Add SKU",
"allowed": true
},
{
"name": "shippingaddress",
"label": "Shipping Address",
"allowed": true
},
{
"name": "shippingmethod",
"label": "Shipping Method",
"allowed": true
},
{
"name": "payment",
"label": "Payment",
"allowed": true
},
{
"name": "promotion",
"label": "Promotion",
"allowed": true
},
{
"name": "othercharges",
"label": "othercharges",
"allowed": true
},
{
"name": "reward",
"label": "Reward",
"allowed": true
}
]
}
],
"action": "Update",
"status": "In_Remorse",
"allowedshippingoption": [
"ShipToStore",
"ShipToHome"
],
"allowedstatus": [
{
"allowedStatus": [
{
"status": "In_Remorse",
"displayName": "In Remorse",
"descriptions": "",
"allowedFlow": "Cancelled"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "Cancel",
"displayName": "Cancel Order"
},
"nextStatus": "Cancelled"
}
],
"action": "Update",
"status": "Submitted_To_Fulfilment",
"allowedshippingoption": [
"BOPIS"
],
"allowedstatus": [
{
"allowedStatus": [
{
"status": "Submitted_To_Fulfilment",
"displayName": "Submitted To Fulfilment",
"descriptions": "",
"allowedFlow": "Cancel"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "Cancel",
"displayName": "BOPIS NotPickedUp Cancel Order"
},
"nextStatus": "Cancelled"
}
],
"action": "Update",
"status": "BOPIS_Ready_To_Pickup",
"allowedshippingoption": [
"BOPIS"
],
"allowedstatus": [
{
"allowedStatus": [
{
"status": "BOPIS_Ready_To_Pickup",
"displayName": "Ready To Pickup",
"descriptions": "",
"allowedFlow": "Cancel"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "Return",
"displayName": "Return Order"
},
"nextStatus": "Returned",
"allowedComponents": []
}
],
"action": "Create",
"status": "STS_Pickedup",
"allowedshippingoption": [
"ShipToStore"
],
"allowedstatus": [
{
"allowedStatus": [
{
"status": "Shipped",
"displayName": "Shipped",
"descriptions": "",
"allowedFlow": "Returned"
},
{
"status": "STS_Ready_To_Pickup",
"displayName": "Ready For Pickup",
"descriptions": "",
"allowedFlow": "Returned"
},
{
"status": "STS_Pickedup",
"displayName": "Picked Up",
"descriptions": "",
"allowedFlow": "Returned"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "Return",
"displayName": "Return Order"
},
"nextStatus": "Returned",
"allowedComponents": []
}
],
"action": "Create",
"status": "Shipped",
"allowedshippingoption": [
"ShipToStore"
],
"allowedstatus": [
{
"allowedStatus": [
{
"status": "Shipped",
"displayName": "Shipped",
"descriptions": "",
"allowedFlow": "Returned"
},
{
"status": "STS_Ready_To_Pickup",
"displayName": "Ready For Pickup",
"descriptions": "",
"allowedFlow": "Returned"
},
{
"status": "STS_Pickedup",
"displayName": "Picked Up",
"descriptions": "",
"allowedFlow": "Returned"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "Return",
"displayName": "Return Order"
},
"nextStatus": "Returned",
"allowedComponents": []
}
],
"action": "Create",
"status": "STS_Ready_To_Pickup",
"allowedshippingoption": [
"ShipToStore"
],
"allowedstatus": [
{
"allowedStatus": [
{
"status": "Shipped",
"displayName": "Shipped",
"descriptions": "",
"allowedFlow": "Returned"
},
{
"status": "STS_Ready_To_Pickup",
"displayName": "Ready For Pickup",
"descriptions": "",
"allowedFlow": "Returned"
},
{
"status": "STS_Pickedup",
"displayName": "Picked Up",
"descriptions": "",
"allowedFlow": "Returned"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "default",
"displayName": "New Order"
},
"nextStatus": "default",
"allowedComponents": [
{
"name": "addsku",
"label": "Add SKU",
"allowed": true
},
{
"name": "shippingaddress",
"label": "Shipping Address",
"allowed": true
},
{
"name": "shippingmethod",
"label": "Shipping Method",
"allowed": true
},
{
"name": "payment",
"label": "Payment",
"allowed": true
},
{
"name": "promotion",
"label": "Promotion",
"allowed": true
},
{
"name": "reward",
"label": "Reward",
"allowed": true
},
{
"name": "othercharges",
"label": "othercharges",
"allowed": true
}
]
}
],
"action": "Update",
"status": "default",
"allowedshippingoption": [
"ShipToStore",
"BOPIS",
"ShipToHome"
],
"allowedstatus": [
{
"allowedStatus": [
{
"status": "default",
"displayName": "default",
"descriptions": "",
"allowedFlow": "default"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "Return",
"displayName": "Return"
},
"nextStatus": "Return_Submitted",
"allowedComponents": [
{
"name": "payment",
"label": "Payment",
"allowed": true
}
]
},
{
"orderType": {
"name": "Replace",
"displayName": "Replace"
},
"nextStatus": "Return_Submitted",
"allowedComponents": [
{
"name": "shippingaddress",
"label": "Shipping Address",
"allowed": true
},
{
"name": "shippingmethod",
"label": "Shipping Method",
"allowed": true
},
{
"name": "payment",
"label": "Payment",
"allowed": true
},
{
"name": "addsku",
"label": "Add SKU",
"allowed": true
}
]
},
{
"orderType": {
"name": "Exchange",
"displayName": "Exchange"
},
"nextStatus": "Return_Submitted",
"allowedComponents": [
{
"name": "addsku",
"label": "Add SKU",
"allowed": true
},
{
"name": "shippingaddress",
"label": "Shipping Address",
"allowed": true
},
{
"name": "shippingmethod",
"label": "Shipping Method",
"allowed": true
},
{
"name": "payment",
"label": "Payment",
"allowed": true
}
]
},
{
"orderType": {
"name": "Correction",
"displayName": "Correction"
},
"nextStatus": "Return_Submitted",
"allowedComponents": [
{
"name": "addsku",
"label": "Add Sku",
"allowed": true
},
{
"name": "payment",
"label": "Payment",
"allowed": true
}
]
}
],
"action": "Create",
"status": "Shipped",
"allowedstatus": [
{
"allowedStatus": [
{
"status": "Shipped",
"displayName": "Shipped",
"descriptions": "",
"allowedFlow": "Return,Replace,Exchange,Correction"
}
]
}
]
},
{
"workflow": [
{
"orderType": {
"name": "Cancel",
"displayName": "Cancel"
},
"nextStatus": "Cancelled"
}
],
"action": "Update",
"status": "Ready_To_Edit",
"allowedstatus": [
{
"allowedStatus": [
{
"status": "Ready_To_Edit",
"displayName": "Ready To Edit",
"descriptions": "",
"allowedFlow": "Cancel"
}
]
}
]
}
] | This attribute defines the order processing workflow based on the order type, such as Return, Replace, Exchange, or No Ship. |
| 10 | shippingLabelImplClass | com.skava.newgisticsplugin.impl.NewgisticsShippingLabelStrategyImpl | This attribute holds the shipping label plug-in of the third-party service. |
| 11 | shippingLabelPluginConfiguration | {"userid":"43895378945","password":<Password>,"domainURL":"https://apiint.newgistics.com/WebAPI/Shipment/","imageURL":"https://apiint.newgistics.com/WebAPI/Shipment/SHIP_ID/Label/Image","apiKey":<AccessKey>} | This attribute holds the configuration details of the third-party service for generating shipping lables. |
| 12 | fetchShippingLabelFromDB | false | This attribute fetches shipping label from the DB when set to true. |
| 13 | defaultBPM | "defaultValue": "DefaultSubmitOrderBPM.xml",
"possibleValues": [
"DefaultSubmitOrderBPM.xml",
"TypesBasedSubmitOrderBPM.xml",
"OrderTypesBasedSubmitOrderBPM.xml"
"MarketplaceSubmitOrderBPM.xml"
] | This attribute indicates the name of the BPM, which needs to be loaded for the submit order process. |
| 14 | integrationDomain | NA | This attribute indicates the domain value, which is used for third party services. |
| 15 | omsIntegration | skava | This attribute specifies the type of the integration opted for the Order service. The possible values can be:skava - Denotes the implementation of Skava's default order services.epoch - Denotes the Epoch Payment Service integration for the order services.
|
| 16 | statusUpdateFieldsConfig | [
{
"status": "Shipped",
"allowedInputs": [
{
"name": "shipmentid",
"type": "string",
"fieldType": null,
"allowedValues": null,
"min": "0",
"max": "1000",
"label": "Shipment ID",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
},
{
"name": "trackingurl",
"type": "string",
"fieldType": null,
"allowedValues": null,
"min": "0",
"max": "1000",
"label": "Tracking URL",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
},
{
"name": "quantity",
"type": "number",
"fieldType": null,
"allowedValues": null,
"min": null,
"max": null,
"label": "Quantity",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
},
{
"name": "shipdate",
"type": "date",
"fieldType": null,
"allowedValues": null,
"min": "0",
"max": "1000",
"label": "Shipment Date",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
}
],
"confirmationMessage": "Are you sure you want to ship the order?",
"actionName": "Shipped"
},
{
"status": "Unable_to_Ship",
"allowedInputs": [
{
"name": "shipmentid",
"type": "string",
"fieldType": null,
"allowedValues": null,
"min": "0",
"max": "1000",
"label": "Shipment ID",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
},
{
"name": "trackingurl",
"type": "string",
"fieldType": null,
"allowedValues": null,
"min": "0",
"max": "1000",
"label": "Tracking URL",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
},
{
"name": "quantity",
"type": "number",
"fieldType": null,
"allowedValues": null,
"min": null,
"max": null,
"label": "Quantity",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
},
{
"name": "shipCanceldate",
"type": "date",
"fieldType": null,
"allowedValues": null,
"min": "0",
"max": "1000",
"label": "Shipment Cancel Date",
"required": true,
"allowedCharacter": "",
"minXPath": null,
"maxXPath": null
}
],
"confirmationMessage": "Are you sure you want to cancel the order shipment ?",
"actionName": "Unable To Ship"
}
] | This attribute contains the configurations of the input fields required for updating the status of the item. |
| 17 | orderMetricflag | false | This property checks whether order summary is executed or not. |
| 18 | remorsePeriodMins | 30 | This property sets up a time duration (in minutes), which will be allowed to update or cancel an order. |
| 19 | isFixedShipping | false | This property checks whether the shipping charges prorated to unprocessed items on partial cancel. |
| 20 | updateOrderCustomValidator | com.skava.oms.validator.services.order.UpdateOrderCustomValidator | This property is an external validator, which is used to validate the integrated services. |
| 21 | updateOrderValidator | com.skava.oms.validator.services.order.CreateOrderFulfilmentTypeValidator,com.skava.oms.validator.services.order.CreateOrderMathDuplicateTypeValidator,com.skava.oms.validator.services.order.CreateOrderDiscountValidator,com.skava.oms.validator.services.order.CreateOrderShippingValidator,com.skava.oms.validator.services.order.CreateOrderGlobalDiscountValidator,com.skava.oms.validator.services.order.OrderLevelTaxProrationValidator,com.skava.oms.validator.services.order.CreateOrderItemPriceValidator,com.skava.oms.validator.services.order.CreateOrderTotalMathValidator,com.skava.oms.validator.services.order.CreateZeroCheckOutOrderValidator | This property contains a list of classes for validations on editing of an order. |
| 22 | additionalLeftNavOptions | [
{
"displayName": "Exchange",
"id": "exchangeOrders",
"orderType": "Exchange",
"icon": "find_replace"
},
{
"displayName": "Replace",
"id": "replaceOrders",
"orderType": "Replace",
"icon": "forward"
},
{
"displayName": "Correction",
"id": "correctionOrders",
"orderType": "Correction",
"icon": "filter_vintage"
}
] | This property allows you to create additional left navigation panel values. |
| 23 | completeorderstauslist | Shipped | This property lists the completed orders with the status defined in the property value like Shipped or Delivered order status. |
| 24 | failedorderstatuslist | Deleted | This property lists the failed orders with the status defined in the property value like Deleted or Fraud Check order status. |
| 25 | fraudCheckInterval | 5 | This property allows you to configure the fraud check interval period (in minutes) after which the based on the response the order will be proceeded accordingly. |
| 26 | orderCategorizationTabs |
[
{
"displayName": "Order Statistics",
"id": "orderStatistics",
"reportTypes": "sales,fulfilment,product,basic",
"enableFilter": true,
"maxDaysAllowed": 180,
"showDefaultDateRanges": false,
"maxNumberOfGroupBy": 3,
"filterOptions": [
{
"report": "sales",
"filters": [
"orders",
"grosssales",
"discounts",
"netsales",
"shipping",
"tax",
"totalsales",
"paymentstatus",
"fulfilmentstatus",
"orderstatus",
"customeremail",
"customerid",
"customername"
]
}
],
"customFields": [
{
"report": "product",
"fields": [
{
"name": "collectionid",
"label": "Collection Id",
"value": "$orderinfo.collectionid",
"operation": "sum",
"type": "integer"
},
{
"name": "storeid",
"label": "Store Id",
"value": "$orderinfo.storeid",
"type": "string"
}
]
},
{
"report": "sales",
"fields": [
{
"name": "collectionid",
"label": "Collection Id",
"value": "$orderinfo.collectionid",
"operation": "sum",
"type": "integer"
},
{
"name": "storeid",
"label": "Store Id",
"value": "$orderinfo.storeid",
"type": "string"
}
]
},
{
"report": "basic",
"fields": [
{
"name": "collectionid",
"label": "Collection Id",
"value": "$orderinfo.collectionid",
"operation": "sum",
"type": "integer"
},
{
"name": "storeid",
"label": "Store Id",
"value": "$orderinfo.storeid",
"type": "string"
}
]
},
{
"report": "fulfilment",
"fields": [
{
"name": "collectionid",
"label": "Collection Id",
"value": "$orderinfo.collectionid",
"operation": "sum",
"type": "integer"
},
{
"name": "storeid",
"label": "Store Id",
"value": "$orderinfo.storeid",
"type": "string"
},
{
"name": "Processing",
"label": "Processing",
"value": "$orderinfo.Processing",
"operation": "sum",
"type": "integer"
}
]
}
]
},
{
"displayName": "Total Orders",
"id": "totalOrders",
"filter": "In_Process|In_Promotion_Validation|In_Payment_Review|In_Inventory_Review|In_Promotion_Assignment|In_Fraud_Review|Fraud_Approved|Ready_To_Update|Created Fulfilment|Ready_To_Edit|Freeze_Edit|Submitted_to_Fulfilment|Shipped",
"orderType": "Default|null"
},
{
"displayName": "In Progress Orders",
"id": "inProgressOrders",
"filter": "In_Process|In_Promotion_Validation|In_Payment_Review|In_Inventory_Review|In_Promotion_Assignment|In_Fraud_Review|Fraud_Approved|Ready_To_Update|Created Fulfilment|Ready_To_Edit|Freeze_Edit",
"orderType": "Default|null"
},
{
"displayName": "Failed Orders",
"id": "failedOrders",
"filter": "Deleted",
"orderType": "Default|null"
}
]
| This property allows you to create order types which will be displayed as tabs like Total Orders, In Progress Orders, Failed Orders, and Back Orders in the Orders' Overview page.
Note: The property maxDaysAllowed allows to fetch the records only as per the defined period. The mentioned value is in days. Otherwise, it will fetch for last 180 days. |
| 27 | price_override_reason_codes | [
{
"reasonCode": "OP",
"reasonMessage": "Website pricing issue"
},
{
"reasonCode": "OP",
"reasonMessage": "Honoring previous promotion"
},
{
"reasonCode": "OP",
"reasonMessage": "Coupon exception"
},
{
"reasonCode": "OP",
"reasonMessage": "price match"
}
] | This property is used to configure price override reasons, which allows a CSR to select a suitable reason for overriding the existing price for the ordered items. |
| 28 | skipTotalCount | FALSE | This attribute is used to skip total count using the "Get Order(s) by Collection ID.
When this property is set to:
true - the API retrieves the total count of the orders.false - the API does not retrieve the total count of the orders.
|
