The following table describes the collection properties for the Order microservice:

S. No.AttributeDefault ValueDescription
1orderidlength14This attribute holds the length of the order ID to be generated. The possible values are from 14 to 25.
2BPM_SubmitOrderThis attribute holds a custom submit order BPM configuration.
3lookupRequiredFieldsusertracking.lastname,
usertracking.zip
This attribute holds the required fields for order lookup.
4isNumericOrderIdOnlyfalseThis attribute is to set the format of the order ID. It is either numeric or alphanumeric. The possible values are true and false.
5skipDefaultQueuepromotion.block/assign, payment.bulkTransactionRequestQueue, inventory.bulktransactions, account.budgettransactionIf 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.
6createOrderValidatorcom.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.
7createOrderCustomValidatorcom.skava.oms.validator.services.order.CreateOrderCustomValidatorIndicates an external validator to validate the integrated services.
8returnAddressThis attribute holds the address to which the product is returned.
9orderConfigurations[{"workflow":[{"orderType":{"name":"Return","displayName":"Return"},"allowedComponents":[{"name":"payment","label":"Payment","allowed":true}]},{"orderType":{"name":"Replace","displayName":"Replace"},"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"},"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"},"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"}}],"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.
10shippingLabelImplClasscom.skava.uspsshippingconnector.strategy.impl.DefaultGetShippingLabelStrategyImplThis attribute holds the shipping label plug-in of the third-party service.
11shippingLabelPluginConfiguration{"userid":"43895378945","password":"345DF4553S4D33","domainURL":"https://apiint.newgistics.com/WebAPI/Shipment/","imageURL":"https://apiint.newgistics.com/WebAPI/Shipment/SHIP_ID/Label/Image","apiKey":"a8a59e7c-9c99-456e-9ef5-74f4ca76900c"}This attribute holds the configuration details of the third-party service for generating shipping lables.
12fetchShippingLabelFromDBfalseThis attribute fetches shipping label from the DB when set to true.
13statusUpdateFieldsConfig[{"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"}]This attribute contains the configuration of the input fields required for updating the item status.
14defaultBPMNAThis attribute indicates the name of the BPM, which needs to be loaded for the submit order process.
15integrationDomainNAThis attribute indicates the domain value, which is used for third party services.
16omsIntegrationskavaThis 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.
17statusUpdateFieldsConfig[
{
"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"
}
]
This attribute contains the configurations of the input fields required for updating the status of the item.
18orderMetricflagfalseThis property checks whether order summary is executed or not.
19remorsePeriodMins30This property sets up a time duration (in minutes), which will be allowed to update or cancel an order.
20isFixedShippingfalseThis property checks whether the shipping charges prorated to unprocessed items on partial cancel.
21updateOrderCustomValidatorNAThis property is an external validator, which is used to validate the integrated services.
22updateOrderValidatorNAThis property contains a list of classes for validations on editing of an order.
23additionalLeftNavOptionsThis property allows you to create additional left navigation panel values.
24completeorderstauslistShippedThis property lists the completed orders with the status defined in the property value like Shipped or Delivered order status.
25failedorderstatuslistDeletedThis property lists the failed orders with the status defined in the property value like Deleted or Fraud Check order status.
26fraudCheckInterval5This 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.
27orderCategorizationTabs[
{
"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|Return_Submitted",
"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|Submitted_to_Fulfilment",
"orderType": "Default|null"
},
{
"displayName": "Failed Orders",
"id": "failedOrders",
"filter": "Deleted",
"orderType": "Default|null"
},
{
"displayName": "Back Orders",
"id": "backOrders",
"filter": "backordered:true",
"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.




Revision History
2021-12-31 | JP – Added collection properties for Release 8.12.
2021-12-31 | JP – Added a collection property for December 2021 release.
2020-10-14 | AN – Added the collection properties.
2020-01-14 | MA – Content updated for February 2020 release.
2019-04-11 | MA – Content updated for April 2019 release.
2019-01-23 | PLK – Page added and content uploaded.