The following table describes the collection properties for the Shipping microservice.

S. No.AttributeDefault ValueDescription
1plugin.shippingzoneNAThis attribute indicates the plugin used for shipping calculations.
2validateCountryCode{
"US": [
"USA",
"America",
"us"
],
"CAN": [
"Canada",
"CN"
]
}		This attribute indicates the aliases of the countries to which shipping is allowed.
3zones[{name:"zone1",country:"US",zipcodeLimit:"*",currency:"USD",shippingMethods:["PHYSICAL.Economy","PHYSICAL.Express"]}]This attribute indicates the list of shipping zones.
4methods{"PHYSICAL.Economy":{"shippingMethodName":"EconomyShipping","description":"Economy Shipping","taxCalculation":{"isTaxable":false,"taxationId":"cybersource"},"baseFee":"0","handlingFee":"0","expectedDeliveryTime":"48","expectedDaysForDelivery":"2","classes":{"DEFAULT":{"value":"0","type":"flat","calculatedAt":["perorder"]}}}}This attribute indicates the list of shipping methods.

Shipping cost calculation can be at the order, quantity, or item level:

  • perorder: Calculate the shipping cost at the order level.

  • perquantity: Calculate the shipping cost at the quantity level.

  • peritem: Calculate the shipping cost at the item level.
5classes[\"DEFAULT\"]This attribute indicates the list of classes associated with the items.
6allowedCountriesUS,USA,Canada,GermanyThis attribute indicates the list of countries to which shipping is allowed.
7calculationExpiryTime0This attribute indicates the expiry time of the shipping charges calculated in milliseconds.
8shippingValidatorsThis attribute indicates a class, which contains the validations on shipping.
For example, com.skava.shipping.validator.service.ShippingCalculationValidator
9shipping.plugin.properties"{
""plugin.prop.name"": ""plugin.prop.value""
}"
This attribute provides predefined data to load the third-party plugins.
10shippingOptions{
"ShipToHome": {
"shippingOptionName": "Ship To Home",
"description": "Ship To Home",
"status": "Active",
"isDefault": "true",
"methods": [
"PHYSICAL.Standard",
"PHYSICAL.Twoday",
"PHYSICAL.Oneday"
]
},
"ShipToStore": {
"shippingOptionName": "Ship To Store",
"description": "Ship To Store",
"status": "Active",
"isDefault": "false",
"methods": [
"PHYSICAL.Shiptostore"
]
},
"BOPIS": {
"shippingOptionName": "Store Pickup",
"description": "Store Pickup",
"status": "Active",
"isDefault": "false"
},
"ShipFromStore": {
"shippingOptionName": "Ship From Store",
"description": "Ship From Store",
"status": "Active",
"isDefault": "false"
}
}		This attribute holds the list of supported shipping options.




Revision History
2023-01-12 | AN – Updated content for 8.13 release.
2020-02-04 | AN – Content updated for February 2020 release.
2019-04-15 | AN- Content updated for April 2019 release.
2019-01-23 | PLK – Page added and content uploaded.