Serialized Form

Package com.skava.oms.adapter.payload

Class com.skava.oms.adapter.payload.PreProcessInventoryItemPayload

class PreProcessInventoryItemPayload extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

binName

String binName

bin name

skuId

String skuId

sku id

transaction

Transaction transaction

Package com.skava.oms.delegate.model

Class com.skava.oms.delegate.model.AccountBudget

class AccountBudget extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountId

String accountId

Specific account Id.

budgetId

String budgetId

collectionId

String collectionId

collectionId.

costCentreId

String costCentreId

description

String description

orderDate

String orderDate

orderId

String orderId

Ordered Date.

type

String type

value

String value

Class com.skava.oms.delegate.model.FraudRule

class FraudRule extends Object implements Serializable

serialVersionUID:

1210263134921834936L

Serialized Fields

function

String function

Function for the fraud node

operation

String operation

Operation for the fraud node

path

String path

Path to be evaluated

value

String value

Value for the fraud node

Class com.skava.oms.delegate.model.Fulfilment

class Fulfilment extends Object implements Serializable

serialVersionUID:

1210263134921834936L

Serialized Fields

fulfilmentItem

List<FulfilmentItem> fulfilmentItem

Shipment with shipment items

orderId

String orderId

Order Id

Class com.skava.oms.delegate.model.FulfilmentItem

class FulfilmentItem extends Object implements Serializable

serialVersionUID:

-4973410442180456734L

Serialized Fields

expectedShipmentDate

String expectedShipmentDate

Expected Shipment date

fulfillmentProvider

String fulfillmentProvider

fulfillmentProvider

fulfilmentInfo

FulfilmentInfo fulfilmentInfo

Fulfilment information

isImmediateShipment

boolean isImmediateShipment

Immediate Shipment Flag

isProcessed

boolean isProcessed

To identify the shipment is processed or not.

lineId

long lineId

Line Id

orderItemId

String orderItemId

Order Item Id

quantity

BigDecimal quantity

Quantity

responseCode

String responseCode

Response code from fulfilment plugin

responseMessage

String responseMessage

Response message from fulfilment plugin

skuId

String skuId

Sku Id

vendor

String vendor

Vendor for the order

Class com.skava.oms.delegate.model.LoyaltyServiceTransaction

class LoyaltyServiceTransaction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdBy

long createdBy

createdOn

long createdOn

identifier

String identifier

orderId

String orderId

responseCode

String responseCode

rewardType

String rewardType

rewardValue

BigDecimal rewardValue

type

LoyaltyReward.TransactionType type

voucherRedemptionIds

List<String> voucherRedemptionIds

voucherRedemptions

List<LoyaltyDetails> voucherRedemptions

Class com.skava.oms.delegate.model.PaymentServicePaymentDetails

class PaymentServicePaymentDetails extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

authToken

String authToken

expDate

String expDate

firstName

String firstName

id

String id

lastName

String lastName

Class com.skava.oms.delegate.model.PaymentServiceTransaction

class PaymentServiceTransaction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

id

Long id

paymentItemId

long paymentItemId

Unique id of paymentItem.

properties

List<PaymentServiceTransaction.Properties> properties

responseCode

String responseCode

responseCode of the Transaction.

responseMessage

String responseMessage

responseCode of the Transaction.

skipPaymentTrans

boolean skipPaymentTrans

skipPaymentTrans

status

PaymentServiceTransaction.Status status

status of the Transaction.

type

PaymentServiceTransaction.Type type

type of the Transaction.

value

BigDecimal value

It consists of value of transaction.

Class com.skava.oms.delegate.model.PaymentServiceTransaction.Properties

class Properties extends Object implements Serializable

serialVersionUID:

-1413602640120083411L

Serialized Fields

name

String name

value

String value

Class com.skava.oms.delegate.model.Promotion

class Promotion extends Response implements Serializable

serialVersionUID:

-4461356568348213963L

Serialized Fields

confirmationCode

String confirmationCode

promoCode

String promoCode

Class com.skava.oms.delegate.model.Property

class Property extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

value

String value

Class com.skava.oms.delegate.model.TaxServiceTransaction

class TaxServiceTransaction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdBy

String createdBy

The unique identifier of the user who created this payment.

createdTime

Date createdTime

transaction created time

id

Long id

properties

List<Property> properties

transaction properties

responseCode

String responseCode

responseCode of the Transaction.

responseMessage

String responseMessage

responseCode of the Transaction.

status

TaxServiceTransaction.Status status

status of the Transaction.

tax

Tax tax

transaction tax

taxItemId

Long taxItemId

Unique id of paymentItem.

transactionType

TaxTransaction.TransactionType transactionType

type of the Transaction.

updatedBy

String updatedBy

transaction updated time

updatedTime

Date updatedTime

transaction updated time

value

BigDecimal value

It consists of value of transaction.

Class com.skava.oms.delegate.model.Transaction

class Transaction extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

atpQty

BigDecimal atpQty

atp quantity

backOrderedQty

BigDecimal backOrderedQty

backorder quantity

id

String id

inventory transaction id

notes

String notes

Defines the notes

preOrderedQty

BigDecimal preOrderedQty

preOrder quantity

properties

String properties

Defines the Properties

refTransactionId

String refTransactionId

inventory refTransactionId

type

Transaction.Type type

Defines the type

Class com.skava.oms.delegate.model.Transaction.Properties

class Properties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

isBundleSku

boolean isBundleSku

lineid

long lineid

orderId

String orderId

orderItemId

String orderItemId

Class com.skava.oms.delegate.model.TransactionResponse

class TransactionResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

responseCode

String responseCode

response Code

responseMessage

String responseMessage

response Message

transaction

TaxServiceTransaction transaction

transaction

Class com.skava.oms.delegate.model.WorkflowResponsePayload

class WorkflowResponsePayload extends Object implements Serializable

serialVersionUID:

-4732634503165868016L

Serialized Fields

responseCode

String responseCode

response Code

responseMessage

String responseMessage

response Message

workflowOutput

String workflowOutput

workflowOutput

Package com.skava.oms.delegate.model.loyalty

Class com.skava.oms.delegate.model.loyalty.LoyaltyDetailsRequest

class LoyaltyDetailsRequest extends Object implements Serializable

serialVersionUID:

-6504266557847930862L

Serialized Fields

accountId

String accountId

accountId

orderId

String orderId

orderId

parentTransactionId

String parentTransactionId

parenTransactionId

rewardType

String rewardType

point

rewardValue

BigDecimal rewardValue

rewardValue

type

String type

point

userId

String userId

userId

userName

String userName

userName

voucherRedemptionIds

List<String> voucherRedemptionIds

voucherRedemptionIds

Class com.skava.oms.delegate.model.loyalty.LoyaltyReward

class LoyaltyReward extends Object implements Serializable

serialVersionUID:

-6504266557847930862L

Serialized Fields

rewardType

String rewardType

Reward Type - LOYALTY, STORECREDIT

tier

String tier

User tier

transactionType

LoyaltyReward.TransactionType transactionType

Transaction Type

value

BigDecimal value

Reward value

voucher

Voucher voucher

Indicates any voucher details associated for that reward

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEvent

class PreProcessLoyaltyEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionId

long collectionId

collection id of the order

loyaltyCollectionId

String loyaltyCollectionId

collection id of the loyalty

orderid

String orderid

order id

transaction

PreProcessLoyaltyEventRequest transaction

list of bin items

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventParams

class PreProcessLoyaltyEventParams extends Object implements Serializable

serialVersionUID:

-6504266557847930862L

Serialized Fields

collectionId

String collectionId

Collection Id

locale

String locale

locale

processMode

String processMode

processMode

userInfo

String userInfo

User info

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest

class PreProcessLoyaltyEventRequest extends Object implements Serializable

serialVersionUID:

-6504266557847930862L

Serialized Fields

items

PreProcessLoyaltyEventRequest.ItemsRequest items

Items in loyalty payload

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest.CustomEventRequest

class CustomEventRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountInfo

PreProcessLoyaltyEventRequest.LoyaltyAccountInfo accountInfo

accountInfo

eventId

String eventId

EventId in event request

isCartLoyaltyGift

boolean isCartLoyaltyGift

isCartLoyaltyGift

orderInfo

PreProcessLoyaltyEventRequest.LoyaltyOrderInfo orderInfo

OrderInfo

rewardInfo

PreProcessLoyaltyEventRequest.LoyaltyRewardInfo rewardInfo

RewardInfo

subscriptionInfo

Map<String,String> subscriptionInfo

subscriptionInfo

totalLoyaltyPoints

String totalLoyaltyPoints

totalLoyaltyPoints

userInfo

PreProcessLoyaltyEventRequest.LoyaltyUserInfo userInfo

UserInfo

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest.ItemsRequest

class ItemsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

customEvent

List<PreProcessLoyaltyEventRequest.CustomEventRequest> customEvent

List of customEvents in reward payload

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest.LoyaltyAccountInfo

class LoyaltyAccountInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountId

String accountId

AccountId

accountLevelLoyalty

boolean accountLevelLoyalty

Account Level Loyalty flag

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest.LoyaltyOrderInfo

class LoyaltyOrderInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdDate

long createdDate

createdDate

id

String id

Order ID

loyaltyEligibleOrderValue

BigDecimal loyaltyEligibleOrderValue

loyalty Eligible Order Value

notes

String notes

Notes

orderGrossValue

BigDecimal orderGrossValue

Order Total Value

otherProperties

Map<String,String> otherProperties

otherProperties

pointVolume

BigDecimal pointVolume

pointVolume

shipmentDetails

List<PreProcessLoyaltyEventRequest.ShipmentDetail> shipmentDetails

List of shipped item details

voucherEligibleOrderValue

BigDecimal voucherEligibleOrderValue

voucher Eligible Order Value

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest.LoyaltyRewardInfo

class LoyaltyRewardInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdDate

long createdDate

createdDate

id

String id

OrderId

notes

String notes

notes

rewardType

String rewardType

Reward Type

tier

String tier

Tier information

value

BigDecimal value

Reward Value

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest.LoyaltyUserInfo

class LoyaltyUserInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

accountId

String accountId

AccountId

accountLevelLoyalty

boolean accountLevelLoyalty

Account Level Loyalty flag

id

String id

User or AccountId

userId

String userId

UserId

userName

String userName

UserName

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequest.ShipmentDetail

class ShipmentDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

itemId

String itemId

ItemId

lineId

String lineId

Line Id

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventRequestPayload

class PreProcessLoyaltyEventRequestPayload extends Object implements Serializable

serialVersionUID:

7204073844614508440L

Serialized Fields

requestBody

String requestBody

PreProcess Loyalty Request

requestParameters

PreProcessLoyaltyEventParams requestParameters

PreProcess Loyalty Request Params

Class com.skava.oms.delegate.model.loyalty.PreProcessLoyaltyEventResponsePayload

class PreProcessLoyaltyEventResponsePayload extends Object implements Serializable

serialVersionUID:

7204073844614508440L

Serialized Fields

responseCode

String responseCode

Response Code

responseMessage

String responseMessage

Response Message

rewards

List<LoyaltyReward> rewards

Loyalty rewardInfo

shipmentDetails

List<PreProcessLoyaltyEventRequest.ShipmentDetail> shipmentDetails

Loyalty shipmentInfo

Class com.skava.oms.delegate.model.loyalty.Voucher

class Voucher extends Object implements Serializable

serialVersionUID:

-6504266557847930861L

Serialized Fields

transactionId

String transactionId

Transaction id

voucherId

String voucherId

Voucher Id

voucherValue

BigDecimal voucherValue

Voucher value

Package com.skava.oms.entity.criteria

Class com.skava.oms.entity.criteria.SearchCriteria

class SearchCriteria extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

key

String key

operation

String operation

Package com.skava.oms.event.model

Class com.skava.oms.event.model.CheckFraudEvent

class CheckFraudEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

fraud

boolean fraud

whether it is a fraud or not

orderid

String orderid

Indicates the orderid in which the fraud check is take place

status

String[] status

status of the order

Class com.skava.oms.event.model.FulfilmentEvent

class FulfilmentEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

fulfilment

Fulfilment fulfilment

fulfilment

Class com.skava.oms.event.model.GetPaymentEvent

class GetPaymentEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionId

long collectionId

collection id of the order

orderid

String orderid

order id in which payment is created

paymentCollectionId

String paymentCollectionId

collection id of the payment

paymentIds

List<String> paymentIds

Id of the payment

Class com.skava.oms.event.model.OmsEvent

class OmsEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Name of the event

Class com.skava.oms.event.model.OrderDelegateEvent

class OrderDelegateEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionId

Long collectionId

This indicates the collection ID of the order

locale

String locale

This indicates the locale of the request

orderId

String orderId

This indicates the identifier of the order, which has to be updated

orderPatchDTO

OrderPatchDTO orderPatchDTO

Indicates the actual data model that has to be updates

paymentTrans

List<PaymentServiceTransaction> paymentTrans

Class com.skava.oms.event.model.PreProcessAccountEvent

class PreProcessAccountEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

accountsCollectionId

String accountsCollectionId

budgets

AccountBudget budgets

collectionId

String collectionId

The collection Id.

orderId

String orderId

The Order Id.

Class com.skava.oms.event.model.PreProcessInventoryEvent

class PreProcessInventoryEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

binItems

List<PreProcessInventoryItemPayload> binItems

list of bin items

collectionId

String collectionId

collection id of the order

inventoryCollectionId

String inventoryCollectionId

collection id of the inventory

orderid

String orderid

order id in which bin is created

Class com.skava.oms.event.model.PreProcessPaymentEvent

class PreProcessPaymentEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

allOrNone

boolean allOrNone

collectionId

long collectionId

collection id of the order

orderid

String orderid

order id in which payment is created

paymentCollectionId

String paymentCollectionId

collection id of the payment

transactions

List<PaymentServiceTransaction> transactions

list of transactions

Class com.skava.oms.event.model.PreProcessPromotionEvent

class PreProcessPromotionEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionId

String collectionId

collection id of the order

orderid

String orderid

order id in which promotion is created

promotionCollectionId

String promotionCollectionId

collection id of promotion

promotionList

List<Promotion> promotionList

list of promotions

type

Promotion.PromotionType type

type of promotion

Class com.skava.oms.event.model.WorkflowAccountEvent

class WorkflowAccountEvent extends OmsEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

accountsCollectionId

String accountsCollectionId

collectionId

String collectionId

The collection Id.

orderDTO

OrderDTO orderDTO

orderId

String orderId

The Order Id.

Package com.skava.oms.exception

Exception com.skava.oms.exception.CommonPluginServiceException

class CommonPluginServiceException extends com.skava.core.ECommerceException implements Serializable

serialVersionUID:

1L

Serialized Fields

pluginResponse

CommonPluginProcessorResponse pluginResponse

Plugin Response

responseCode

ResponseCode responseCode

ResponseCode

Exception com.skava.oms.exception.OmsServiceException

class OmsServiceException extends com.skava.core.ECommerceException implements Serializable

serialVersionUID:

1L

Serialized Fields

responseCode

ResponseCode responseCode

Exception com.skava.oms.exception.OmsValidateException

class OmsValidateException extends com.skava.core.ECommerceException implements Serializable

serialVersionUID:

-1800237265898207567L

Package com.skava.oms.flow

Class com.skava.oms.flow.OrderMessageTracker

class OrderMessageTracker extends Object implements Serializable

serialVersionUID:

1326016093542535220L

Serialized Fields

businesskey

String businesskey

business key of the process.

collectionid

long collectionid

Collection Id in which the order is created

item

OrderItem item

itemid

String itemid

Sub Level Id of the created order. It can be a order item id or any tracking sub level id.

itemlevel

boolean itemlevel

Check the changes in order level or item level

orderid

String orderid

Order Id of the created order

orderItem

ArrayList<OrderItem> orderItem

shouldWaitForUserTask

boolean shouldWaitForUserTask

spanId

String spanId

Span Id created by Sleuth to Track Order events

startmessage

String startmessage

Starting message of the process.

sublevelid

long sublevelid

Sub Level Id of the created order. It can be a item line id or any tracking sub level id.

traceId

String traceId

Trace Id created by Sleuth to Track Order events

Package com.skava.oms.model.dto.collection

Class com.skava.oms.model.dto.collection.CollectionAttributeDTO

class CollectionAttributeDTO extends Object implements Serializable

serialVersionUID:

-1761108348057847407L

Serialized Fields

defaultValue

String defaultValue

The collection id.

description

String description

The collection id.

name

String name

The collection id.

nullable

boolean nullable

The attribute emptiness of the attribute.

possibleValues

List<String> possibleValues

The possible values of the attribute.

type

String type

The type of the attribute.

Class com.skava.oms.model.dto.collection.CollectionDTO

class CollectionDTO extends Object implements Serializable

serialVersionUID:

8667319996328485622L

Serialized Fields

businessId

long businessId

businessid that the collection associated to

createdBy

String createdBy

user who created the collection

createdTime

Date createdTime

collection created time

description

@Size(min=2,max=1000) String description

collection description

id

long id

collection id

name

@Size(min=2,max=255) String name

name of the collection

properties

@Valid CollectionPropertiesDTO[] properties

status

Collection.Status status

status of the collection

updatedBy

String updatedBy

user who updated the collection

updatedTime

Date updatedTime

collection updated time

Class com.skava.oms.model.dto.collection.CollectionPropertiesDTO

class CollectionPropertiesDTO extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

name

@NotNull @Pattern(regexp="^[a-zA-Z][\\w]*$",message="Name should start with an alphabet and can be an alphaNumeric. Allowing \'_\' alone.") String name

name of the collection property

value

String value

value for the collection property

Class com.skava.oms.model.dto.collection.PageableInfoDTO

class PageableInfoDTO extends Object implements Serializable

serialVersionUID:

-1160703660294714537L

Serialized Fields

count

int count

This param contains the number of entries displayed

page

int page

This param contains the page

size

int size

This param contains the size

totalCount

long totalCount

This param contains the number of entries present

Package com.skava.oms.model.dto.order

Class com.skava.oms.model.dto.order.ActionHistoryDTO

class ActionHistoryDTO extends Object implements Serializable

serialVersionUID:

-4152085491694859547L

Serialized Fields

actionquantity

BigDecimal actionquantity

This contains the action quantity value

childorderid

String childorderid

Indicates the child order id

createdtime

long createdtime

Indicates the created time of the action

id

@jakarta.validation.constraints.NotNull,@jakarta.validation.constraints.NotEmpty long id

This contains the id of the action

nextstatus

String[] nextstatus

Next possible fulfilment status, the action could be moved to

otherproperties

Map<String,String> otherproperties

contains the extra information about an order given in

quantity

BigDecimal quantity

This contains the quantity value

referenceid

@NotNull @NotEmpty Long[] referenceid

This contains the reference id of the action

status

@NotNull @NotEmpty String status

Fulfilment type, the action currently in

type

@NotNull @NotEmpty String type

This contains the type of the action

updatedtime

long updatedtime

Indicates the Updated time of the action

Class com.skava.oms.model.dto.order.AddressDTO

class AddressDTO extends Object implements Serializable

serialVersionUID:

-4152085491694859547L

Serialized Fields

address1

@NotNull @NotEmpty String address1

address2

String address2

Address line 2 of the user whose address is to be given

address3

String address3

Address line 3 of the user whose address is to be given

city

@NotNull @NotEmpty String city

City of the user whose address is to be givenA

companyname

String companyname

If the given address is company address, then company name should be given

country

@NotNull @NotEmpty String country

Country of the user whose address is to be given

county

String county

General area of the user whose address is to be given

deliveryinstruction

String deliveryinstruction

This contains the delivery instruction for the address

email

@NotNull @NotEmpty String email

Country of the user whose address is to be given

firstname

@NotNull @NotEmpty String firstname

This contains the first name of the user

lastname

@NotNull @NotEmpty String lastname

This contains the last name of the user

middlename

String middlename

This contains the middle name of the user

phone

@NotNull @NotEmpty String phone

Country of the user whose address is to be given

state

@NotNull @NotEmpty String state

State of the user whose address is to be given

type

String type

This contains the type of address whether it is office or residential

zip

String zip

ZipCode of the user whose address is to be given

Class com.skava.oms.model.dto.order.AddressRequest

class AddressRequest extends Object implements Serializable

serialVersionUID:

-8117674097841116266L

Serialized Fields

address1

String address1

Field to hold address of the location

address2

String address2

Field to hold address of the location

address3

String address3

Field to hold address of the location

city

String city

Field to hold city of the location

country

String country

Field to hold country of the location

latitude

double latitude

Field to hold latitude of the location

longitude

double longitude

Field to hold longitude of the location

phoneNumber

String phoneNumber

Field to hold phone number of the location

postalCode

String postalCode

Field to hold postal code of the location

state

String state

Field to hold state of the location

Class com.skava.oms.model.dto.order.AllowedInputsDTO

class AllowedInputsDTO extends Object implements Serializable

serialVersionUID:

-6140157979386957466L

Serialized Fields

allowedCharacter

String allowedCharacter

Indicates allowedCharacter value of allowedValues

allowedValues

String[] allowedValues

Quantity detailed of allowdValues for order

label

String label

Indicates label value of allowedValues

max

String max

Indicates max value of allowedValues

maxXPath

String maxXPath

Indicates xMaxPath value of allowedValues

min

String min

Indicates minimum value of allowedValues

minXPath

String minXPath

Indicates xMinPath value of allowedValues

name

String name

Indicates the name of allowedInputs for order

required

boolean required

Indicates required value of allowedValues

type

String type

Type of the allowedInputs for order

Class com.skava.oms.model.dto.order.AllowedPatchFieldsDTO

class AllowedPatchFieldsDTO extends Object implements Serializable

serialVersionUID:

-42199361209950022L

Serialized Fields

actionName

String actionName

Contains the ActionName related information of an order

allowedInputs

AllowedInputsDTO[] allowedInputs

Contains the allowedInputs related information of an order

confirmationMessage

String confirmationMessage

Contains the confirmationMessage related information of an order

status

String status

Indicates the status for the particular order

Class com.skava.oms.model.dto.order.ContactInfoDTO

class ContactInfoDTO extends Object implements Serializable

serialVersionUID:

3114963211794523238L

Serialized Fields

email

@NotNull @Email String email

Email of the user whose address is to be given

phone

@NotNull String phone

Phone number of the user whose address is to be given

preferredcontact

@NotNull ContactMethod preferredcontact

Preferred contact of the user If they have given more than one

Class com.skava.oms.model.dto.order.DiscountDTO

class DiscountDTO extends Object implements Serializable

serialVersionUID:

5062264139894845262L

Serialized Fields

code

String code

Contains the discount code

confirmationcode

String confirmationcode

Contains the confirmation code which is used to confirm the code for applying the discount. This field can be null or empty.

description

String description

Contains the description of the discount. This field can be null or empty.

discountclass

String discountclass

Contains the discount class

frequencyIdentifier

String frequencyIdentifier

frequencyIdentifier

frequencyType

FrequencyType frequencyType

frequencyType

frequencyValue

String frequencyValue

frequencyValue

isGift

Boolean isGift

isGift

level

DiscountLevel level

Contains the discount level which is of item or order or personalization

matchedSkuIds

List<String> matchedSkuIds

matchedSkuIds

mode

@NotNull String mode

Mode in which the payment is made

name

String name

Contains the name of the discount. This field can be null or empty.

offerid

@NotNull String offerid

Indicates the offer Id applied for the discount

otherproperties

HashMap<String,String> otherproperties

Extra information about the discount represented as JSON String

parentitem

String parentitem

Indicates the parent item of the discount. For example, if the discount is "Buy 1 Get 1", then the buying product is the parent item.

priceinfo

@Valid @NotNull DiscountPriceInfoDTO priceinfo

productId

String productId

productId

promotionClass

String promotionClass

Contains the promotionclass information

promotionGroup

String promotionGroup

Contains the promotionGroup information

quantity

BigDecimal quantity

quantity

skuId

String skuId

skuId

Class com.skava.oms.model.dto.order.DiscountPriceInfoDTO

class DiscountPriceInfoDTO extends Object implements Serializable

serialVersionUID:

-5032800568137960573L

Serialized Fields

taxinfo

@Valid TaxInfoDTO taxinfo

totalcost

BigDecimal totalcost

totaldiscount

BigDecimal totaldiscount

unitcost

BigDecimal unitcost

unitdiscount

BigDecimal unitdiscount

Unit discount for the order/orderitem

Class com.skava.oms.model.dto.order.EditLockDTO

class EditLockDTO extends Object implements Serializable

serialVersionUID:

1383569009764453360L

Serialized Fields

component

Component component

The component which had acquired this lock

lockDuration

int lockDuration

Lock duration in minutes

user

String user

The user who had acquired this lock

Class com.skava.oms.model.dto.order.EventSchedule

class EventSchedule extends Object implements Serializable

serialVersionUID:

3507931634158530849L

Serialized Fields

eventId

String eventId

schedule

List<Schedule> schedule

Contains list of schedule

Class com.skava.oms.model.dto.order.FraudDTO

class FraudDTO extends Object implements Serializable

serialVersionUID:

-521911597756520393L

Serialized Fields

createdtime

long createdtime

Contains the created time for fraud of an order or an order item if exist.

history

FraudHistoryDTO history

id

@NotNull String id

Indicates the Fraud Id

notes

String notes

Indicates the notes for the fraud

reason

FraudReasonDTO[] reason

Indicates the Fraud reason

status

FraudStatus status

Indicates the Fraud Status

type

FraudType type

Indicates the Fraud type

updatedtime

long updatedtime

Class com.skava.oms.model.dto.order.FraudHistoryDTO

class FraudHistoryDTO extends Object implements Serializable

serialVersionUID:

-5797326064726879568L

Serialized Fields

createdtime

long createdtime

Contains the created time for fraud of an order or an order item if exist.

reason

FraudReasonDTO reason

Contains the reason for being fraud of an order or an order item if exist.

status

FraudStatus status

Contains the status for fraud of an order or an order item if exist.

Class com.skava.oms.model.dto.order.FraudReasonDTO

class FraudReasonDTO extends Object implements Serializable

serialVersionUID:

566477177926913466L

Serialized Fields

code

String code

message

String message

Class com.skava.oms.model.dto.order.FulfilMathDTO

class FulfilMathDTO extends Object implements Serializable

serialVersionUID:

5769924529450558480L

Serialized Fields

estfulfilcost

BigDecimal estfulfilcost

estfulfilsale

BigDecimal estfulfilsale

estfulfiltax

BigDecimal estfulfiltax

fulfilcost

BigDecimal fulfilcost

fulfildiscount

BigDecimal fulfildiscount

fulfilsale

BigDecimal fulfilsale

fulfiltax

BigDecimal fulfiltax

totalfulfilsale

BigDecimal totalfulfilsale

typeBasedFulfilCost

HashMap<String,BigDecimal> typeBasedFulfilCost

Indicates the typeBasedFulfilCost

typeBasedFulfilDiscount

HashMap<String,BigDecimal> typeBasedFulfilDiscount

Indicates the typeBasedFulfilDiscount

typeBasedFulfilSale

HashMap<String,BigDecimal> typeBasedFulfilSale

Indicates the typeBasedFulfilSale

typeBasedFulfilTax

HashMap<String,BigDecimal> typeBasedFulfilTax

Indicates the typeBasedFulfilTax

typeBasedTotalFulfilSale

HashMap<String,BigDecimal> typeBasedTotalFulfilSale

Indicates the typeBasedTotalFulfilSale

Class com.skava.oms.model.dto.order.FulfilmentIdDTO

class FulfilmentIdDTO extends Object implements Serializable

serialVersionUID:

6066908641579899019L

Serialized Fields

id

long id

status

String status

Class com.skava.oms.model.dto.order.FulfilmentInfoDTO

class FulfilmentInfoDTO extends Object implements Serializable

serialVersionUID:

6229573094189218389L

Serialized Fields

fulfilmentid

FulfilmentIdDTO fulfilmentid

Unique ID for fulfilment

returnaddress

AddressDTO returnaddress

returnmethod

ShippingMethodDTO returnmethod

shipmentdate

long shipmentdate

Shipment date

shipmentid

String shipmentid

Unique ID for shipment

shippingaddress

AddressDTO shippingaddress

Address to which the orderitem to be shipped

shippingcontact

@Valid ContactInfoDTO shippingcontact

shippingLabelImage

String shippingLabelImage

shippingLabelURL

String shippingLabelURL

shippingmethod

@Valid ShippingMethodDTO shippingmethod

Contains the shipping method of an order or an order item

storeLocation

@Valid StoreLocationDTO storeLocation

trackingurl

String trackingurl

tracking url

type

@NotNull String type

Indicates which type of delivery process for this item. Ex: digital, Physical

Class com.skava.oms.model.dto.order.Hour

class Hour extends Object implements Serializable

serialVersionUID:

4809149849620191262L

Serialized Fields

description

String description

Field to hold a description for Hour

hoursType

String hoursType

Field to hold the Hour type like working/lunch/closed

name

String name

Field to hold a name for Hour

overrides

List<OverrideTimeIntervel> overrides

Field to hold the hours that can be used as override hour from the regular hours

standardHours

StandardHours standardHours

Field to hold a standard hours of a week

Class com.skava.oms.model.dto.order.Image

class Image extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

2079476165075739571L

Serialized Fields

caption

String caption

Field to hold caption of location image

description

String description

Field to hold description of location image

url

String url

Field to hold url of location image

Class com.skava.oms.model.dto.order.InventoryDTO

class InventoryDTO extends Object implements Serializable

serialVersionUID:

8843409199645707960L

Serialized Fields

blocktransaction

String blocktransaction

Class com.skava.oms.model.dto.order.ItemDTO

class ItemDTO extends Object implements Serializable

serialVersionUID:

-1400023950722328389L

Serialized Fields

backordered

boolean backordered

Indicates whether the item was prebooked or not

binid

@NotNull @NotEmpty String binid

Indicates the Identifier of the inventory bin.

info

ItemInfoDTO info

This contains the information about the item

maxpurchasequantity

BigDecimal maxpurchasequantity

Maximum quantity allowed to purchase

minpurchasequantity

BigDecimal minpurchasequantity

otherproperties

HashMap<String,String> otherproperties

Additional information about the item. Data must be in JSON Format

pid

@NotNull String pid

Indicates the Unique Identifier of the Product

preordered

boolean preordered

Indicates whether the item was prebooked or not

priceinfo

@Valid ItemPriceInfoDTO[] priceinfo

Indicates the price information of item.

productType

SkuType productType

Indicates the product id of the item. Unique Id of the the product type

skuid

@NotNull @NotEmpty String skuid

Indicates the Sku id of the item. Unique Id of the the sku

specialProducts

SpecialProductsDTO[] specialProducts

This contains the information about the specialProducts

taxcode

String taxcode

Indicates the type of tax code applied on the order item.

unitMath

TotalValueMathDTO unitMath

upc

String upc

Indicates the Universal Product Code (UPC), that are uniquely assigned to each trade item.

vendor

String vendor

weightUnits

String weightUnits

Weight of the item. Weight in units

weightValue

String weightValue

Weight of the item. Total weight

Class com.skava.oms.model.dto.order.ItemInfoDTO

class ItemInfoDTO extends Object implements Serializable

serialVersionUID:

3629191715221923145L

Serialized Fields

categoryid

String categoryid

This is used to identify the category of this item

color

String color

description

String description

Detailed description about the item

dimension

String dimension

fit

String fit

fulfillmentProvider

String fulfillmentProvider

image

String image

Image of the item. URL or file location of the item image

link

String link

Link of the item. link to the product details page

name

String name

Name of the item

size

String size

style

String style

Class com.skava.oms.model.dto.order.ItemPriceInfoDTO

class ItemPriceInfoDTO extends Object implements Serializable

serialVersionUID:

-8084675035048723146L

Serialized Fields

conversionratio

BigDecimal conversionratio

Contains the conversion ratio of the item.

costprice

BigDecimal costprice

Contains the cost price of an item. The minimum value is 0.00.

mode

String mode

Mode in which the payment is made

regprice

BigDecimal regprice

roundoff

BigDecimal roundoff

The adjustment value of the currency type. The lower bound of the currency type

saleprice

BigDecimal saleprice

saveprice

BigDecimal saveprice

taxinfo

@Valid TaxInfoDTO taxinfo

Contains tax information of an personalization

Class com.skava.oms.model.dto.order.LocationProperty

class LocationProperty extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

locale

String locale

name

String name

value

String value

Holds the value of the location property

Class com.skava.oms.model.dto.order.LockedOrderPatchFieldsDTO

class LockedOrderPatchFieldsDTO extends Object implements Serializable

serialVersionUID:

7903222869321909823L

Serialized Fields

forceRelease

boolean forceRelease

indicates forceRelease or not

thresholdLockTime

long thresholdLockTime

value of thresholdLockTime

Class com.skava.oms.model.dto.order.LoyaltyDetailsDTO

class LoyaltyDetailsDTO extends Object implements Serializable

serialVersionUID:

-1627666239047853983L

Serialized Fields

id

String id

Indicates the id

points

BigDecimal points

Indicates the loaylty reward points

transaction

LoyaltyServiceTransactionDTO[] transaction

Loyalty transactions

type

String type

Indicates the reward type

value

BigDecimal value

Indicates the loaylty reward value

valueType

ValueType valueType

Indicates the valueType of the loaylty reward

voucherId

String voucherId

Indicates the voucherId of the loyalty reward

voucherType

String voucherType

Indicates the voucherType of the loyalty reward

Class com.skava.oms.model.dto.order.LoyaltyServiceTransactionDTO

class LoyaltyServiceTransactionDTO extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdBy

long createdBy

createdOn

long createdOn

identifier

String identifier

orderId

String orderId

responseCode

String responseCode

rewardType

String rewardType

rewardValue

BigDecimal rewardValue

type

LoyaltyReward.TransactionType type

voucherRedemptionIds

List<String> voucherRedemptionIds

voucherRedemptions

List<LoyaltyDetails> voucherRedemptions

Class com.skava.oms.model.dto.order.MathDTO

class MathDTO extends Object implements Serializable

serialVersionUID:

7913575564821698804L

Serialized Fields

cost

BigDecimal cost

discount

BigDecimal discount

discountcost

BigDecimal discountcost

esttax

BigDecimal esttax

fulfilmath

FulfilMathDTO fulfilmath

Contains the fulfilmath

isPriceInclusiveOftax

Boolean isPriceInclusiveOftax

isPriceInclusiveOftax

mode

String mode

Contains the mode

otherCharges

BigDecimal otherCharges

Specifies the other variable charges.

otherChargesIncludingTax

BigDecimal otherChargesIncludingTax

Specifies the other charges including tax.

paymentid

String paymentid

Contains the payment id

personalizationcost

BigDecimal personalizationcost

Indicates the cost price of the personalization

personalizationdiscount

BigDecimal personalizationdiscount

personalizationsale

BigDecimal personalizationsale

roundoff

BigDecimal roundoff

sale

BigDecimal sale

tax

BigDecimal tax

taxable

BigDecimal taxable

taxOnOtherCharges

BigDecimal taxOnOtherCharges

Specifies the tax on the other charges.

totalsale

BigDecimal totalsale

type

String type

Contains the type

Class com.skava.oms.model.dto.order.MessageResendPatchFieldsDTO

class MessageResendPatchFieldsDTO extends Object implements Serializable

serialVersionUID:

5033759073374206139L

Serialized Fields

isExternalEvent

boolean isExternalEvent

Denotes whether external Event

type

@NotNull String type

Message Type

Class com.skava.oms.model.dto.order.NoteDTO

class NoteDTO extends Object implements Serializable

serialVersionUID:

-521911597756520393L

Serialized Fields

createdby

String createdby

createdtime

long createdtime

description

String description

Indicates the description of the note.

type

NoteType type

Indicates the note type

usertype

NoteUserType usertype

Indicates the note user type

Class com.skava.oms.model.dto.order.NotificationDTO

class NotificationDTO extends Object implements Serializable

serialVersionUID:

5006848438123155895L

Serialized Fields

createdby

String createdby

Indicates the user who created the notification.

createdtime

Long createdtime

Indicates the timestamp when the notification was created

description

String description

Indicates the description of the notification.

id

Long id

Contains the ID of the notification.

itemid

String itemid

Indicates the ID of the item to which the notification is sent.

paymentitemid

String paymentitemid

Indicates the ID of the payment item which is associated with the item ID.

properties

HashMap<String,Object> properties

Indicates the properties of the notification. It should be given in key value format.

status

String status

Indicates the status of the notification.

type

String type

Indicates the type of the notification.

updatedtime

Long updatedtime

Indicates the timestamp when the notification was created

Class com.skava.oms.model.dto.order.NotificationPatchDTO

class NotificationPatchDTO extends Object implements Serializable

serialVersionUID:

-4152085491694859547L

Serialized Fields

note

NoteDTO note

notification

NotificationDTO[] notification

notification

Class com.skava.oms.model.dto.order.OrderDetailsDTO

class OrderDetailsDTO extends Object implements Serializable

serialVersionUID:

280121494245003938L

Serialized Fields

discounts

@Valid DiscountDTO[] discounts

Contains the discount of an order

fulfilmentinfo

@Valid FulfilmentInfoDTO fulfilmentinfo

Contains the shipping information of an order

loyaltyDetails

@Valid LoyaltyDetailsDTO[] loyaltyDetails

Indicates the loyalty reward details

ordertaxinfo

@Valid OrderTaxInfoDTO[] ordertaxinfo

Contains the tax information of an order

otherCharges

@Valid OtherChargesDTO[] otherCharges

Contains the other charges for an order

Class com.skava.oms.model.dto.order.OrderDTO

class OrderDTO extends Object implements Serializable

serialVersionUID:

-42199361209950022L

Serialized Fields

allowedPatchFields

AllowedPatchFieldsDTO[] allowedPatchFields

Contains the AllowedPatchInput contains the order related information.

failedReason

Map<String,String> failedReason

Indicates the failedreason for the order

fraud

FraudDTO[] fraud

Contains the fraud related information of an order

id

String id

Indicates the unique ID given to the order

itemLevelPatchAllowed

boolean itemLevelPatchAllowed

Indicates the allows patch update for item level

math

@Valid MathDTO[] math

Contains the math related calculations of an order

nextstatus

String[] nextstatus

Next possible fulfillment status, the order could be moved to

notes

NoteDTO[] notes

Contains the descriptions/comments of the order

orderdetails

@Valid OrderDetailsDTO orderdetails

orderdisplaystatus

String orderdisplaystatus

Indicates the display status for the particular order based on order status

orderinfo

@Valid OrderInfoDTO orderinfo

Indicates the unique ID given to the order

orderitems

@NotNull @Valid OrderItemDTO[] orderitems

Indicates the orderitems for the order

orderstatus

String orderstatus

Indicates the single status for the particular order based on item's fulfilment status

otherproperties

HashMap<String,String> otherproperties

contains the extra information about an order given in

payments

@Valid PaymentDTO[] payments

Contains the payment related information of an order

specialProducts

SpecialProductsDTO[] specialProducts

status

String[] status

Indicates the status for the particular order

taxitem

TaxItemDTO taxitem

transactions

OrderTransactionDTO[] transactions

Contains the transactions made on the order

usertracking

@NotNull @Valid UserTrackingDTO usertracking

Contains the user tracking information of an order

Class com.skava.oms.model.dto.order.OrderInfoDTO

class OrderInfoDTO extends Object implements Serializable

serialVersionUID:

7670006746506397258L

Serialized Fields

affiliateid

String affiliateid

channel

@NotNull String channel

collectionid

long collectionid

Indicates the collection Id for the particular order

createdby

String createdby

Indicates the created user of the order

createdtime

long createdtime

Indicates the created time of the order

deletable

boolean deletable

Indicates the deletable flag for the order

editable

boolean editable

Indicates the editable flag for the order

effectiveorderdate

long effectiveorderdate

Indicates the effective order date for back orders

eventId

String eventId

eventName

String eventName

locale

String locale

notification

NotificationDTO[] notification

notification

ordertype

String ordertype

Indicates the order workflow type such as Return, Replace, Exchange and DEFAULT.

parentorderid

String parentorderid

Indicates the parent order number for which new order has been created for return, replace , exchange

storeid

@NotNull String storeid

storename

String storename

updatedby

String updatedby

updatedtime

long updatedtime

Indicates the Updated time of the order

version

String version

Indicates the version for the particular order

Class com.skava.oms.model.dto.order.OrderItemDTO

class OrderItemDTO extends Object implements Serializable

serialVersionUID:

-8849074280091536103L

Serialized Fields

aggregatestatus

String[] aggregatestatus

Combined status of the orderItem

allowedPatchFields

AllowedPatchFieldsDTO[] allowedPatchFields

Contains the AllowedPatchInput contains the order related information.

discounts

@Valid DiscountDTO[] discounts

Applicable discount codes that can be applied to the order item

displaystatus

String displaystatus

Display fulfilment status, the order item could be moved to

fulfilmentinfo

@Valid FulfilmentInfoDTO fulfilmentinfo

contains the fulfilemnt information

id

@NotNull String id

A unique id given to the orderitem

inventory

InventoryDTO inventory

Inventory information about the orderItem

item

@NotNull @Valid ItemDTO item

Contains the orderItem's properties

lineid

String lineid

Indicates the unique line ID given to the order which is used while splitting

loyaltyDetails

@Valid LoyaltyDetailsDTO[] loyaltyDetails

Indicates the loyalty reward details

math

@Valid MathDTO[] math

Math details about the order item

mathordershipping

@Valid MathDTO[] mathordershipping

Math details about the order item for shipping

mathordertax

@Valid MathDTO[] mathordertax

Math details about the order item for tax

nextstatus

String[] nextstatus

Next possible fulfilment status, the order item could be moved to

orderType

String orderType

Referral order item id of the parent order item type

originallineid

String originallineid

Indicates the line ID given to the order while creation

otherCharges

@Valid OtherChargesDTO[] otherCharges

Contains the other charges for an item

otherproperties

HashMap<String,String> otherproperties

parentItemId

String parentItemId

Referral order item id of the parent order item id

parentLineId

String parentLineId

Referral order item id of the parent line item id

personalization

@Valid PersonalizationDTO[] personalization

Personalization about the orderItem for the user

priceinfo

@Valid ItemPriceInfoDTO[] priceinfo

quantity

@NotNull @Min(1L) BigDecimal quantity

Count of the item being ordered

returnable

@jakarta.validation.constraints.NotNull boolean returnable

Indicates whether the product allowed to return

returnType

@jakarta.validation.constraints.NotNull boolean returnType

rewardmath

RewardMathDTO[] rewardmath

Reward Math details about the order item

status

@NotNull String status

Fulfilment type, the orderitem currently in

statustransaction

StatusTransactionDTO[] statustransaction

Transactions made while changing the status

storeid

String storeid

storeLocation

StoreLocationDTO storeLocation

storename

String storename

Class com.skava.oms.model.dto.order.OrderItemPatchDTO

class OrderItemPatchDTO extends Object implements Serializable

serialVersionUID:

-4152085491694859547L

Serialized Fields

id

@NotNull String id

Indicates the unique identifier of the item

otherproperties

HashMap<String,Object> otherproperties

Indicates the Other properties of this particular order

properties

String properties

Indicates the properties of the order item that needs to be patched

quantity

@Min(0L) BigDecimal quantity

Indicates the quantity of the order item that needs to be patched

reasoncode

String reasoncode

Indicates the reason code for the order operation

reasonmessage

String reasonmessage

Indicates the reason message for the order operation

returnable

boolean returnable

Indicates whether this item is returnable or not

returnType

@jakarta.validation.constraints.NotNull boolean returnType

skuId

String skuId

Indicates the sku of the order item that needs to be patched

status

@NotNull String status

Indicates the status of the order item that needs to be patched

Class com.skava.oms.model.dto.order.OrderPatchDTO

class OrderPatchDTO extends Object implements Serializable

serialVersionUID:

-4152085491694859547L

Serialized Fields

note

NoteDTO note

orderItemPatchDTO

@Valid OrderItemPatchDTO[] orderItemPatchDTO

otherproperties

HashMap<String,Object> otherproperties

Indicates the Other properties of this particular order

paymentDTO

@Valid PaymentDTO[] paymentDTO

properties

String properties

Indicates the properties of the order

reasoncode

String reasoncode

Indicates the reason code for the order operation

reasonmessage

String reasonmessage

Indicates the reason message for the order operation

status

String status

Indicates the status of the order

userPatchDTO

@Valid UserPatchDTO userPatchDTO

userTrackingDTO

UserTrackingDTO userTrackingDTO

Indicates the User details of this particular order

Class com.skava.oms.model.dto.order.OrderTaxInfoDTO

class OrderTaxInfoDTO extends Object implements Serializable

serialVersionUID:

-3094400876123105657L

Serialized Fields

mode

String mode

taxcode

String taxcode

Contains code made for the tax on the order

taxinfo

@Valid TaxInfoDTO taxinfo

Class com.skava.oms.model.dto.order.OrderTransactionDTO

class OrderTransactionDTO extends TransactionDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

math

MathDTO math

nextStates

String[] nextStates

Next possible states of the order

orderitemid

String orderitemid

Class com.skava.oms.model.dto.order.OtherChargesDTO

class OtherChargesDTO extends Object implements Serializable

serialVersionUID:

-9026477520617787913L

Serialized Fields

calculatedTotalValue

BigDecimal calculatedTotalValue

Indicates the total calculated value for this other charge element.

calculatedUnitValue

BigDecimal calculatedUnitValue

Indicates the calculated value per unit of this other charge element.

chargeAgainst

String chargeAgainst

Indicates if the variable cost is charged against returned item or new item.

chargeSource

String chargeSource

Indicates the source on which the percent charge needs to be applied.

chargeType

String chargeType

Indicates the charge type like percentage or flat rate to calculate the variable price.

chargeValue

BigDecimal chargeValue

Indicates value of this other charge element.

chargeValueOverridable

boolean chargeValueOverridable

Indicates whether this other charge is editable or not.

description

String description

Holds the description of this other charge element.

mode

@NotNull String mode

name

String name

Name of the other charge.

properties

Map<String,String> properties

Indicates properties map.

taxable

boolean taxable

Indicates whether this other charge element is taxable or not.

type

String type

Indicates the type of the elements on which the other charge is applied.

waivedByDefault

boolean waivedByDefault

Indicates whether this other charge is waived y default or not.

waiveOverridable

boolean waiveOverridable

Indicates whether the waive on this other charge is overridable or not.

Class com.skava.oms.model.dto.order.OverrideTimeIntervel

class OverrideTimeIntervel extends Object implements Serializable

serialVersionUID:

3357874252666725661L

Serialized Fields

dateEnd

String dateEnd

Field to hold end date of override time

dateStart

String dateStart

Field to hold start date of override time

description

String description

Field to hold description of override time

hours

TimeInterval hours

Field to hold hours of override time

name

String name

Field to hold name of override time

Class com.skava.oms.model.dto.order.PaymentDTO

class PaymentDTO extends Object implements Serializable

serialVersionUID:

-6140157979386957466L

Serialized Fields

chargepriority

int chargepriority

format

@NotNull String format

Format used for payment

id

@NotNull String id

Indicates the Unique Id for payment

mode

@NotNull String mode

which mode the payment can be processed

paymentitems

@Valid PaymentItemDTO[] paymentitems

Detailed information about the payment. Based on the maxamount the array will be extended

refundpriority

int refundpriority

transaction

PaymentTransactionDTO[] transaction

Indicates the transaction

type

@NotNull String type

Type of the payment

value

@NotNull BigDecimal value

Class com.skava.oms.model.dto.order.PaymentItemDTO

class PaymentItemDTO extends Object implements Serializable

serialVersionUID:

-8150429304766014123L

Serialized Fields

id

String id

Indicates the current status of the particular paymen

otherproperties

HashMap<String,String> otherproperties

Related detailes about the payment item in JSON format

paymentrefid

@NotNull String paymentrefid

Indicates the payment reference id of the particular payment

status

PaymentStatus status

Indicates the current status of the particular payment

transactionid

String transactionid

Indicates the transaction Id for the payment item

transactiontype

String transactiontype

Indicates the transaction type for the payment item

value

@NotNull BigDecimal value

Amount of payment processed by the particular provider

Class com.skava.oms.model.dto.order.PaymentTransactionDTO

class PaymentTransactionDTO extends TransactionDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

paymentrefid

String paymentrefid

paymentrefid

transactioncode

String transactioncode

transactioncode

value

BigDecimal value

value

Class com.skava.oms.model.dto.order.PersonalizationDTO

class PersonalizationDTO extends Object implements Serializable

serialVersionUID:

-7986625854129817692L

Serialized Fields

id

@NotNull String id

Contains the specific ID for personalization

message

String message

priceinfo

@Valid PersonalizationPriceInfoDTO[] priceinfo

receipt

boolean receipt

Indicates the boolean value to represent whether the receipt is attached or not.

skuid

String skuid

Indicates the unique identifier of a SKU for an order or an item.

wrap

String wrap

Class com.skava.oms.model.dto.order.PersonalizationPriceInfoDTO

class PersonalizationPriceInfoDTO extends Object implements Serializable

serialVersionUID:

3978078637305279746L

Serialized Fields

conversionratio

BigDecimal conversionratio

Mode in which the converionratio used to convert to product value is made

discount

@Valid DiscountDTO[] discount

Discount information

mode

@NotNull String mode

Mode in which the payment is made

taxinfo

@Valid TaxInfoDTO taxinfo

Tax information

totalpersonalizationcost

BigDecimal totalpersonalizationcost

totalpersonalizationprice

BigDecimal totalpersonalizationprice

unitpersonalizationcost

BigDecimal unitpersonalizationcost

unitpersonalizationprice

BigDecimal unitpersonalizationprice

Class com.skava.oms.model.dto.order.ReturnLabelDTO

class ReturnLabelDTO extends Object implements Serializable

serialVersionUID:

3441342007297719829L

Serialized Fields

returnLabel

byte[] returnLabel

Contains the label information in the form of byte array

Class com.skava.oms.model.dto.order.RewardMathDTO

class RewardMathDTO extends Object implements Serializable

serialVersionUID:

7913575564821698804L

Serialized Fields

approvedPoints

BigDecimal approvedPoints

earnedPoints

BigDecimal earnedPoints

otherproperties

HashMap<String,String> otherproperties

contains the extra information about an order given in

reversedPoints

BigDecimal reversedPoints

rewardType

String rewardType

contains the reward type of the reward

rewardValue

BigDecimal rewardValue

tier

String tier

Contains the tier

transaction

RewardTransactionDTO[] transaction

Contains the transactions made on the order

transactionType

String transactionType

contains the transactiontype of latest transaction done in reward

Class com.skava.oms.model.dto.order.RewardTransactionDTO

class RewardTransactionDTO extends TransactionDTO implements Serializable

serialVersionUID:

1L

Serialized Fields

eventId

String eventId

eventId

rewardtype

String rewardtype

rewardtype

transactiontype

String transactiontype

transactiontype

value

BigDecimal value

value

Class com.skava.oms.model.dto.order.Schedule

class Schedule extends Object implements Serializable

serialVersionUID:

3650456055939901209L

Serialized Fields

endTime

LocalDateTime endTime

Field to hold the end time of interval

startTime

LocalDateTime startTime

Field to hold the start time of interval

Class com.skava.oms.model.dto.order.ShippingMethodDTO

class ShippingMethodDTO extends Object implements Serializable

serialVersionUID:

-6832720171443808918L

Serialized Fields

code

String code

Shipping code of the shipping method which is customized based on the user

deliverystore

String deliverystore

Delivery store

deliveryterm

String deliveryterm

Delivery term

expectedshipmentdatetime

long expectedshipmentdatetime

User expected delivery in timestamp

name

String name

Name of the shipping method which is customized based on the user

otherproperties

HashMap<String,String> otherproperties

Extra properties about shipping

pickupPersonDetails

HashMap<String,String> pickupPersonDetails

pickupPersonDetails

priceinfo

@Valid ShippingMethodPriceInfoDTO[] priceinfo

Class com.skava.oms.model.dto.order.ShippingMethodPriceInfoDTO

class ShippingMethodPriceInfoDTO extends Object implements Serializable

serialVersionUID:

3219191679547806766L

Serialized Fields

conversionratio

BigDecimal conversionratio

cost

BigDecimal cost

Contains the Cost price for shipping method. It should have 0.01 as minimum and it can maximum of 2

discountinfo

@Valid DiscountDTO[] discountinfo

Discount information

estcost

BigDecimal estcost

Contains the Estimated cost price for a shipping method.

estprice

BigDecimal estprice

mode

@NotNull String mode

price

BigDecimal price

Contains the Sale price for shipping method.

taxinfo

@Valid TaxInfoDTO taxinfo

Tax information

Class com.skava.oms.model.dto.order.SpecialProductItemInfoDTO

class SpecialProductItemInfoDTO extends Object implements Serializable

serialVersionUID:

3629191715221923145L

Serialized Fields

categoryid

String categoryid

This is used to identify the category of this item

color

String color

description

String description

Detailed description about the item

dimension

String dimension

fit

String fit

image

String image

Image of the item. URL or file location of the item image

link

String link

Link of the item. link to the product details page

name

String name

Name of the item

size

String size

style

String style

Class com.skava.oms.model.dto.order.SpecialProductsDTO

class SpecialProductsDTO extends Object implements Serializable

serialVersionUID:

8077181834521489808L

Serialized Fields

actionhistory

ActionHistoryDTO[] actionhistory

aggregatestatus

String[] aggregatestatus

Combined status of the special product

discounts

@Valid DiscountDTO[] discounts

Applicable discount codes that can be applied to the special product

displaystatus

String displaystatus

Display fulfilment status, the order item could be moved to

info

SpecialProductItemInfoDTO info

itemMath

TotalValueMathDTO itemMath

nextstatus

String[] nextstatus

Next possible fulfilment status, the order item could be moved to

otherproperties

Map<String,String> otherproperties

price

BigDecimal price

Indicates the price given to the special product

priceFacets

Map<String,Object> priceFacets

productId

String productId

Indicates the productid given to the special product

skuId

String skuId

Indicates the skuid given to the special product

skuQuantity

BigDecimal skuQuantity

Indicates the skuquantity given to the special product

status

String status

Fulfilment type, the orderitem currently in

tax

BigDecimal tax

Indicates the taxation details

type

String type

Indicates the type given to the special product

unitMath

TotalValueMathDTO unitMath

Class com.skava.oms.model.dto.order.StandardHours

class StandardHours extends Object implements Serializable

serialVersionUID:

3507931634158530849L

Serialized Fields

friday

List<TimeInterval> friday

Field to hold time interval of friday

monday

List<TimeInterval> monday

Field to hold time interval of monday

saturday

List<TimeInterval> saturday

Field to hold time interval of saturday

sunday

List<TimeInterval> sunday

Field to hold time interval of sunday

thursday

List<TimeInterval> thursday

Field to hold time interval of thursday

tuesday

List<TimeInterval> tuesday

Field to hold time interval of tuesday

wednesday

List<TimeInterval> wednesday

Field to hold time interval of wednesday

Class com.skava.oms.model.dto.order.StatusTransactionDTO

class StatusTransactionDTO extends Object implements Serializable

serialVersionUID:

-1842636136695795411L

Serialized Fields

id

String id

status

String status

Class com.skava.oms.model.dto.order.StoreLocationDTO

class StoreLocationDTO extends Object implements Serializable

serialVersionUID:

3994485441850470940L

Serialized Fields

address

AddressRequest address

addressField

String addressField

binId

String binId

collectionId

long collectionId

distance

Double distance

distantUnit

DistantUnit distantUnit

enableShipFromStore

boolean enableShipFromStore

enableShipToStore

boolean enableShipToStore

enableStorePickup

boolean enableStorePickup

events

List<EventSchedule> events

fromPropertyService

boolean fromPropertyService

hours

List<Hour> hours

identifier

String identifier

images

List<Image> images

latitude

double latitude

locale

String locale

locationType

String locationType

longitude

double longitude

name

String name

properties

List<LocationProperty> properties

proximity

double proximity

status

LocationStatus status

tags

List<String> tags

timeZone

String timeZone

Class com.skava.oms.model.dto.order.TaxInfoDTO

class TaxInfoDTO extends Object implements Serializable

serialVersionUID:

3441342007297719829L

Serialized Fields

esttax

BigDecimal esttax

isPriceInclusiveOftax

Boolean isPriceInclusiveOftax

isPriceInclusiveOftax

tax

BigDecimal tax

taxable

BigDecimal taxable

Contains the taxable amount of an item.

taxrate

BigDecimal taxrate

Contains the tax percentage of an item.

Class com.skava.oms.model.dto.order.TaxItemDTO

class TaxItemDTO extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currencyCode

String currencyCode

Indicates the currency code of the tax item

id

String id

Indicates the unique ID given to the tax item

otherproperties

HashMap<String,String> otherproperties

Indicates the otherProperties

profileId

String profileId

Indicates the profile id given to the tax item

provider

String provider

Indicates the provider of the tax item

status

String status

Indicates the status of the tax item

taxrefid

String taxrefid

Indicates the reference transaction ID given to the tax item

taxTransactions

List<TaxTransactionDTO> taxTransactions

Indicates the taxTransactions

transactionid

String transactionid

Indicates the transaction ID of the tax item

transactiontype

String transactiontype

Indicates the reference transaction type of the tax item

value

int value

Indicates tax item value

Class com.skava.oms.model.dto.order.TaxTransactionDTO

class TaxTransactionDTO extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

component

int component

Indicates the component where the transaction is being created

createdby

String createdby

Indicates the created by of the transaction created

createdTime

Date createdTime

Indicates the created time of the transaction created

currentstatus

String currentstatus

Indicates the current status of the tax transaction

description

String description

Indicates the description

id

long id

Indicates the unique ID given to the transaction

otherproperties

Map<String,String> otherproperties

Indicates the otherProperties

refTransactionId

String refTransactionId

Indicates the reference transaction ID given to the transaction

responsecode

String responsecode

Indicates the response code of the transaction created

responsemessage

String responsemessage

Indicates the response message of the transaction created

taxItemId

long taxItemId

Indicates the unique ID given to the tax item

transactioncode

String transactioncode

Indicates the transaction code

transactionType

TaxTransaction.TransactionType transactionType

Indicates the type of the transaction

type

String type

Indicates the type

updatestatus

String updatestatus

Indicates the update status of the transaction

value

BigDecimal value

Indicates the total tax value

Class com.skava.oms.model.dto.order.TimeInterval

class TimeInterval extends Object implements Serializable

serialVersionUID:

3650456055939901209L

Serialized Fields

description

String description

Field to hold the description of interval

endTime

String endTime

Field to hold the end time of interval

startTime

String startTime

Field to hold the start time of interval

type

String type

Field to hold the type if time interval like working/lunch/closed

Class com.skava.oms.model.dto.order.TotalValueMathDTO

class TotalValueMathDTO extends Object implements Serializable

serialVersionUID:

-1627666239047853983L

Serialized Fields

originalPrice

BigDecimal originalPrice

Indicates the original total price of all the SKU

priceAfterDiscount

BigDecimal priceAfterDiscount

Specifies the price after discount for all the SKU

priceFacets

Map<String,Object> priceFacets

Indicates the priceFacets of the SKU

priceRoundoff

BigDecimal priceRoundoff

Indicates the price roundoff of the sku

roundoff

BigDecimal roundoff

Indicates the total discount of the sku

tax

BigDecimal tax

Indicates the tax value of the sku price

taxRoundoff

BigDecimal taxRoundoff

Indicates the total discount of the sku

totaldiscount

BigDecimal totaldiscount

Indicates the total discount of the sku

Class com.skava.oms.model.dto.order.TransactionDTO

class TransactionDTO extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

component

int component

component

createdby

String createdby

Indicates the created user

createdtime

long createdtime

Indicates the created time

currentstatus

String currentstatus

previousstatus

description

String description

description

id

String id

A unique id given to the Transaction

otherproperties

HashMap<String,String> otherproperties

otherproperties

responsecode

String responsecode

responsecode

responsemessage

String responsemessage

responsemessage

type

TransactionType type

type

updatestatus

String updatestatus

nextstatus

Class com.skava.oms.model.dto.order.UserPatchDTO

class UserPatchDTO extends Object implements Serializable

serialVersionUID:

1208102519779704134L

Serialized Fields

email

String email

holds the user email id

userid

@NotNull String userid

holds the userid

Class com.skava.oms.model.dto.order.UserTrackingDTO

class UserTrackingDTO extends Object implements Serializable

serialVersionUID:

4409503675368275572L

Serialized Fields

accountid

String accountid

accountid

budgetId

String budgetId

budgetId

costcentre

String costcentre

costcentre

firstname

@NotNull @NotEmpty String firstname

First name of the user who placed the order

guestuser

boolean guestuser

guestuser

guestuserid

String guestuserid

guestuserid

ip

String ip

ip

lastname

@NotNull String lastname

lastname

usercontact

@Valid ContactInfoDTO usercontact

usercontact

userid

String userid

userid

zip

String zip

zip

Package com.skava.oms.model.entity.collection

Class com.skava.oms.model.entity.collection.Collection

class Collection extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

businessId

long businessId

createdBy

String createdBy

createdTime

Date createdTime

description

String description

id

long id

name

String name

properties

CollectionProperties[] properties

status

Collection.Status status

updatedBy

String updatedBy

updatedTime

Date updatedTime

Class com.skava.oms.model.entity.collection.CollectionProperties

class CollectionProperties extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

name

@Pattern(regexp="^[a-zA-Z][\\w]*$",message="Name should start with an alphabet and can be an alphaNumeric. Allowing \'_\' alone.") @NotNull String name

The name.

value

String value

The value.

Package com.skava.oms.model.entity.order

Class com.skava.oms.model.entity.order.ActionHistory

class ActionHistory extends Object implements Serializable

serialVersionUID:

1472257024057231335L

Serialized Fields

actionquantity

BigDecimal actionquantity

Holds action quantity

childorderid

String childorderid

Holds child order id

createdtime

long createdtime

Holds createdtime

id

long id

Holds id

nextstatus

String[] nextstatus

Holds nextstatus of order item

otherproperties

Map<String,String> otherproperties

Holds otherproperties

quantity

BigDecimal quantity

Holds item quantity

referenceid

Long[] referenceid

Holds referenceid

status

String status

Holds status of order item

type

String type

Holds item type

updatedtime

long updatedtime

Holds updatedtime

Class com.skava.oms.model.entity.order.Address

class Address extends Object implements Serializable

serialVersionUID:

-4152085491694859547L

Serialized Fields

address1

String address1

Address line 1 of the user whose address is to be given

address2

String address2

Address line 2 of the user whose address is to be given

address3

String address3

Address line 3 of the user whose address is to be given

city

String city

City of the user whose address is to be givenA

companyname

String companyname

If the given address is company address, then company name should be given

country

String country

Country of the user whose address is to be given

county

String county

General area of the user whose address is to be given

deliveryinstruction

String deliveryinstruction

This contains the delivery instruction for the address

email

String email

Email of the user whose address is to be given

firstname

String firstname

This contains the first name of the user

lastname

String lastname

This contains the last name of the user

middlename

String middlename

This contains the middle name of the user

phone

String phone

Phone number of the user whose address is to be given

preferredcontact

ContactMethod preferredcontact

Prefered contact of the user If they have given more than one

state

String state

State of the user whose address is to be given

type

String type

This contains the type of address whether it is office or residential

zip

String zip

ZipCode of the user whose address is to be given

Class com.skava.oms.model.entity.order.AllowedInputs

class AllowedInputs extends Object implements Serializable

serialVersionUID:

-6140157979386957466L

Serialized Fields

allowedCharacter

String allowedCharacter

Indicates allowedCharacter value of allowedValues

allowedValues

String[] allowedValues

Quantity detailed of allowdValues for order

label

String label

Indicates label value of allowedValues

max

String max

Indicates max value of allowedValues

maxXPath

String maxXPath

Indicates xMaxPath value of allowedValues

min

String min

Indicates minimum value of allowedValues

minXPath

String minXPath

Indicates xMinPath value of allowedValues

name

String name

Indicates the name of allowedInputs for order

required

boolean required

Indicates required value of allowedValues

type

String type

Type of the allowedInputs for order

Class com.skava.oms.model.entity.order.AllowedPatchFields

class AllowedPatchFields extends Object implements Serializable

serialVersionUID:

-42199361209950022L

Serialized Fields

actionName

String actionName

Contains the ActionName related information of an order

allowedInputs

AllowedInputs[] allowedInputs

Contains the allowedInputs related information of an order

confirmationMessage

String confirmationMessage

Contains the confirmationMessage related information of an order

status

String status

Indicates the status for the particular order

validationNotRequired

boolean validationNotRequired

Indicates the boolean value to check whether the reason code validation is required or not.

Class com.skava.oms.model.entity.order.ContactInfo

class ContactInfo extends Object implements Serializable

serialVersionUID:

-5966385574260740575L

Serialized Fields

email

String email

Email of the user whose address is to be given

phone

String phone

Phone number of the user whose address is to be given

preferredcontact

ContactMethod preferredcontact

Prefered contact of the user If they have given more than one

Class com.skava.oms.model.entity.order.Discount

class Discount extends Object implements Serializable

serialVersionUID:

5062264139894845262L

Serialized Fields

code

String code

Contains the discount code

confirmationcode

String confirmationcode

description

String description

discountclass

String discountclass

Contains the discount class

frequencyIdentifier

String frequencyIdentifier

frequencyIdentifier

frequencyType

FrequencyType frequencyType

frequencyType

frequencyValue

String frequencyValue

frequencyValue

isGift

Boolean isGift

isGift

level

DiscountLevel level

Contains the discount level which is of item or order or personalization

matchedSkuIds

List<String> matchedSkuIds

matchedSkuIds

mode

String mode

Mode in which the payment is made

name

String name

offerid

String offerid

Offer ID for the discount

otherproperties

HashMap<String,String> otherproperties

Extra information about the discount represented as JSON String

parentitem

String parentitem

priceinfo

DiscountPriceInfo priceinfo

Indicates the price information in discount

productId

String productId

productId

promotionClass

String promotionClass

Contains Promotion Class

promotionGroup

String promotionGroup

Contains Promotion Group

quantity

BigDecimal quantity

quantity

skuId

String skuId

skuId

Class com.skava.oms.model.entity.order.DiscountPriceInfo

class DiscountPriceInfo extends Object implements Serializable

serialVersionUID:

-5032800568137960573L

Serialized Fields

taxinfo

TaxInfo taxinfo

Information related to tax

totalcost

BigDecimal totalcost

Total cost of the discount

totaldiscount

BigDecimal totaldiscount

Total discount given to the order/orderitem

unitcost

BigDecimal unitcost

Unit cost of the discount

unitdiscount

BigDecimal unitdiscount

Unit discount for the order/orderitem

Class com.skava.oms.model.entity.order.Fraud

class Fraud extends Object implements Serializable

serialVersionUID:

-521911597756520393L

Serialized Fields

createdtime

long createdtime

history

FraudHistory history

id

String id

Indicates the Fraud Id

notes

String notes

Indicates the notes for the fraud

reason

FraudReason[] reason

Indicates the Fraud reason

status

FraudStatus status

Indicates the Fraud Status

type

FraudType type

Indicates the Fraud type

updatedtime

long updatedtime

Class com.skava.oms.model.entity.order.FraudHistory

class FraudHistory extends Object implements Serializable

serialVersionUID:

-5797326064726879568L

Serialized Fields

createdtime

long createdtime

reason

FraudReason reason

status

FraudStatus status

Class com.skava.oms.model.entity.order.FraudReason

class FraudReason extends Object implements Serializable

serialVersionUID:

566477177926913466L

Serialized Fields

code

String code

message

String message

Class com.skava.oms.model.entity.order.FulfilMath

class FulfilMath extends Object implements Serializable

serialVersionUID:

5769924529450558480L

Serialized Fields

estfulfilcost

BigDecimal estfulfilcost

Indicates the unit shipping price for the estimated cost price

estfulfilsale

BigDecimal estfulfilsale

Indicates the unit shipping price for the estimated sale price

estfulfiltax

BigDecimal estfulfiltax

Indicates the estimated shipping cost price

fulfilcost

BigDecimal fulfilcost

Indicates the shipping price for the cost price

fulfildiscount

BigDecimal fulfildiscount

Indicates the shipping discount

fulfilsale

BigDecimal fulfilsale

Indicates the shipping price for the sale price

fulfiltax

BigDecimal fulfiltax

Indicates the shipping tax

totalfulfilsale

BigDecimal totalfulfilsale

Indicates the shipping sale value after the discount

typeBasedFulfilCost

HashMap<String,BigDecimal> typeBasedFulfilCost

typeBasedFulfilDiscount

HashMap<String,BigDecimal> typeBasedFulfilDiscount

typeBasedFulfilSale

HashMap<String,BigDecimal> typeBasedFulfilSale

typeBasedFulfilTax

HashMap<String,BigDecimal> typeBasedFulfilTax

typeBasedTotalFulfilSale

HashMap<String,BigDecimal> typeBasedTotalFulfilSale

Class com.skava.oms.model.entity.order.FulfilmentId

class FulfilmentId extends Object implements Serializable

serialVersionUID:

6066908641579899019L

Serialized Fields

id

long id

status

String status

Class com.skava.oms.model.entity.order.FulfilmentInfo

class FulfilmentInfo extends Object implements Serializable

serialVersionUID:

6229573094189218389L

Serialized Fields

fulfilmentid

FulfilmentId fulfilmentid

Unique ID for fulfilment

returnaddress

Address returnaddress

returnmethod

ShippingMethod returnmethod

shipmentdate

long shipmentdate

Shipment date

shipmentid

String shipmentid

Unique ID for Shipment

shippingaddress

Address shippingaddress

Address to which the orderitem to be shipped

shippingcontact

ContactInfo shippingcontact

shippingLabelImage

String shippingLabelImage

Shipping label image URL

shippingLabelURL

String shippingLabelURL

Shipping label vendor application URL

shippingmethod

ShippingMethod shippingmethod

storeLocation

StoreLocation storeLocation

trackingurl

String trackingurl

Unique ID for Shipment

type

String type

Indicates which type of delivery process for this item. Ex: digital, Physical

Class com.skava.oms.model.entity.order.Inventory

class Inventory extends Object implements Serializable

serialVersionUID:

8843409199645707960L

Serialized Fields

blocktransaction

String blocktransaction

Class com.skava.oms.model.entity.order.Item

class Item extends Object implements Serializable

serialVersionUID:

-1400023950722328389L

Serialized Fields

backordered

boolean backordered

Indicates whether the item was backordered or not

binid

String binid

info

ItemInfo info

This contains the information about the item

maxpurchasequantity

BigDecimal maxpurchasequantity

Maximum quantity allowed to purchase

minpurchasequantity

BigDecimal minpurchasequantity

Minimum quantity allowed to purchase

otherCharges

OtherCharges[] otherCharges

Specifies other charges for this item.

otherproperties

HashMap<String,String> otherproperties

Additional information about the item. Data must be in JSON Format

pid

@NotNull String pid

preordered

boolean preordered

Indicates whether the item was prebooked or not

priceinfo

@NotNull @Valid ItemPriceInfo[] priceinfo

productType

SkuType productType

skuid

@NotNull String skuid

specialProducts

SpecialProducts[] specialProducts

This contains the information about specialproducts

taxcode

String taxcode

unitMath

TotalValueMath unitMath

Specifies total Price, Pricefacets and Discounts.

upc

String upc

vendor

String vendor

weightUnits

String weightUnits

Weight of the item. Weight in units

weightValue

String weightValue

Weight of the item. Total weight

Class com.skava.oms.model.entity.order.ItemInfo

class ItemInfo extends Object implements Serializable

serialVersionUID:

3629191715221923145L

Serialized Fields

categoryid

String categoryid

This is used to identify the category of this item

color

String color

description

String description

Detailed description about the item

dimension

String dimension

fit

String fit

fulfillmentProvider

String fulfillmentProvider

fulfillmentProvider of the item

image

String image

Image of the item. URL or file location of the item image

link

String link

Link of the item. link to the product detailes page

name

String name

Name of the item

size

String size

style

String style

Class com.skava.oms.model.entity.order.ItemPriceInfo

class ItemPriceInfo extends Object implements Serializable

serialVersionUID:

-8084675035048723146L

Serialized Fields

conversionratio

BigDecimal conversionratio

Mode in which the conversionratio is used to convert value

costprice

BigDecimal costprice

mode

String mode

Mode in which the payment is made

regprice

BigDecimal regprice

Indicates the item's Regular price

roundoff

BigDecimal roundoff

saleprice

BigDecimal saleprice

Indicates the item's Sale price

saveprice

BigDecimal saveprice

The total amount reduced from original price

taxinfo

@Valid TaxInfo taxinfo

Class com.skava.oms.model.entity.order.Items

class Items extends Object implements Serializable

serialVersionUID:

5379829626446791824L

Serialized Fields

deliverToAddress

TaxAddress deliverToAddress

The Delivery Address.

discount

BigDecimal discount

The shippingDiscount.

id

String id

The id.

itemDeliveredAlone

boolean itemDeliveredAlone

The boolean to check if it can be shipped alone.

itemProperties

Map<String,String> itemProperties

The item properties as mapping object.

itemVersion

long itemVersion

The item address Version.

quantity

BigDecimal quantity

The quantity.

shippingDiscount

BigDecimal shippingDiscount

The shippingDiscount.

shippingPrice

BigDecimal shippingPrice

The shippingPrice.

shippingTaxationId

String shippingTaxationId

The shippingTaxationId.

skuDetails

List<ItemsSKU> skuDetails

The item skuDetails

Class com.skava.oms.model.entity.order.ItemsSKU

class ItemsSKU extends Object implements Serializable

serialVersionUID:

5379829626446791824L

Serialized Fields

discount

BigDecimal discount

The skuDiscount.

id

String id

The id.

name

String name

The name.

price

BigDecimal price

The price.

productId

String productId

The productId.

quantity

BigDecimal quantity

The price.

skuId

String skuId

The skuId.

skuProperties

Map<String,String> skuProperties

The SKU properties.

skuType

SkuType skuType

The type.

taxAtionId

String taxAtionId

The skuTaxationId.

Class com.skava.oms.model.entity.order.LoyaltyDetails

class LoyaltyDetails extends Object implements Serializable

serialVersionUID:

-6140157979386957466L

Serialized Fields

id

String id

Indicates the id

points

BigDecimal points

Indicates the loaylty reward points

transaction

LoyaltyServiceTransaction[] transaction

Loyalty transactions

type

String type

Indicates the reward type

value

BigDecimal value

Indicates the loaylty reward value

valueType

ValueType valueType

Indicates the valueType of the loaylty reward

voucherId

String voucherId

Indicates the voucherId of the loyalty reward

voucherType

String voucherType

Indicates the voucherType of the loyalty reward

Class com.skava.oms.model.entity.order.Math

class Math extends Object implements Serializable

serialVersionUID:

7913575564821698804L

Serialized Fields

conversionratio

BigDecimal conversionratio

cost

BigDecimal cost

Indicates the Cost price

discount

BigDecimal discount

Indicates the discount

discountcost

BigDecimal discountcost

Indicates the discount cost

esttax

BigDecimal esttax

fulfilmath

FulfilMath fulfilmath

Contains the fulfilmath

isPriceInclusiveOftax

Boolean isPriceInclusiveOftax

isPriceInclusiveOftax

mode

String mode

Contains the mode

otherCharges

BigDecimal otherCharges

Specifies the other variable charges.

otherChargesIncludingTax

BigDecimal otherChargesIncludingTax

Specifies the other charges including tax.

paymentid

String paymentid

Contains the payment id

personalizationcost

BigDecimal personalizationcost

personalizationdiscount

BigDecimal personalizationdiscount

personalizationsale

BigDecimal personalizationsale

roundoff

BigDecimal roundoff

sale

BigDecimal sale

Contains the sale

tax

BigDecimal tax

taxable

BigDecimal taxable

taxOnOtherCharges

BigDecimal taxOnOtherCharges

Specifies the tax on the other charges.

totalsale

BigDecimal totalsale

type

String type

Contains the type

Class com.skava.oms.model.entity.order.Note

class Note extends Object implements Serializable

serialVersionUID:

-521911597756520393L

Serialized Fields

createdby

String createdby

Indicates the created user of the note

createdtime

String createdtime

Indicates the created time of the note

description

String description

Indicates the Note description

type

NoteType type

Indicates the type of the note

usertype

NoteUserType usertype

Indicates the user type of the note

Class com.skava.oms.model.entity.order.Notification

class Notification extends Object implements Serializable

serialVersionUID:

5006848438123155895L

Serialized Fields

createdby

String createdby

createdtime

Long createdtime

description

String description

id

Long id

itemid

String itemid

paymentitemid

String paymentitemid

properties

HashMap<String,Object> properties

status

String status

type

String type

updatedtime

Long updatedtime

Class com.skava.oms.model.entity.order.Order

class Order extends OrderExtended implements Serializable

serialVersionUID:

7420605155551614218L

Serialized Fields

allowedPatchFields

AllowedPatchFields[] allowedPatchFields

fraud

Fraud[] fraud

id

String id

Indicates the unique ID given to the order

math

Math[] math

nextstatus

String[] nextstatus

Next possible fulfilment status, the order could be moved to

orderdetails

OrderDetails orderdetails

Indicates the global information about the order

orderdisplaystatus

String orderdisplaystatus

Indicates the display status for the particular order based on order status

orderinfo

OrderInfo orderinfo

Indicates the unique ID given to the order

orderitems

OrderItem[] orderitems

Indicates the orderitems for the order

orderprocessinfo

OrderProcessInfo orderprocessinfo

orderstatus

String orderstatus

Indicates the single status for the particular order based on item's fulfilment status

otherproperties

HashMap<String,String> otherproperties

payments

Payment[] payments

status

String[] status

Indicates the status for the particular order

taxitem

TaxItem taxitem

transactions

OrderTransaction[] transactions

usertracking

UserTracking usertracking

Class com.skava.oms.model.entity.order.OrderData

class OrderData extends Object implements Serializable

serialVersionUID:

7420605155551614218L

Serialized Fields

averageOrderAmount

BigDecimal averageOrderAmount

Indicates the averageOrderAmount given to the order

backOrder

long backOrder

Indicates the backOrder for the particular order

collectionid

long collectionid

Indicates the collection Id for the particular order

createdtime

Date createdtime

date

long date

Indicates the date information about the order

failedOrder

long failedOrder

Indicates the failedOrder for the order

id

String id

inProgressOrders

long inProgressOrders

Indicates the inProgressOrders given to the order

orderTotal

BigDecimal orderTotal

Indicates the orderTotal information about the order

totalOrder

long totalOrder

Indicates the backOrder for the particular order

updatedtime

Date updatedtime

Class com.skava.oms.model.entity.order.OrderDetails

class OrderDetails extends Object implements Serializable

serialVersionUID:

280121494245003938L

Serialized Fields

discounts

Discount[] discounts

fulfilmentinfo

FulfilmentInfo fulfilmentinfo

loyaltyDetails

LoyaltyDetails[] loyaltyDetails

ordertaxinfo

OrderTaxInfo[] ordertaxinfo

otherCharges

OtherCharges[] otherCharges

Specifies other charges for this order.

Class com.skava.oms.model.entity.order.OrderEntity

class OrderEntity extends Object implements Serializable

serialVersionUID:

7420605155551614218L

Class com.skava.oms.model.entity.order.OrderExtended

class OrderExtended extends Object implements Serializable

serialVersionUID:

7420605155551614218L

Serialized Fields

itemLevelPatchAllowed

boolean itemLevelPatchAllowed

Indicates whether to allow patch update at the item level or not.

notes

Note[] notes

It has the list of notes for the order. Each note has the descriptions/comments, note created time and note created User

Class com.skava.oms.model.entity.order.OrderInfo

class OrderInfo extends Object implements Serializable

serialVersionUID:

7670006746506397258L

Serialized Fields

affiliateid

String affiliateid

channel

String channel

collectionid

long collectionid

Indicates the collection Id for the particular order

createdby

String createdby

Indicates the created user of the order

createdtime

long createdtime

Indicates the created time of the order

deletable

boolean deletable

Indicates the deletable flag for the order

editable

boolean editable

Indicates the editable flag for the order

effectiveorderdate

long effectiveorderdate

Indicates the effective order date for back orders

eventId

String eventId

eventName

String eventName

locale

String locale

notification

Notification[] notification

Indicates notification message for the order

ordertype

String ordertype

Indicates the order workflow type such as Return, Replace, Exchange and DEFAULT.

parentorderid

String parentorderid

Indicates the parent order number for which new order has been created for return, replace , exchange

storeid

String storeid

storename

String storename

updatedby

String updatedby

updatedtime

long updatedtime

Indicates the Updated time of the order

version

String version

Indicates the version for the particular order

Class com.skava.oms.model.entity.order.OrderItem

class OrderItem extends Object implements Serializable

serialVersionUID:

-8849074280091536103L

Serialized Fields

aggregatestatus

String[] aggregatestatus

allowedPatchFields

AllowedPatchFields[] allowedPatchFields

deletable

boolean deletable

discounts

Discount[] discounts

Applicable discount codes that can be applied to the order item

displaystatus

String displaystatus

Display fulfilment status, the order item could be moved to

fulfilmentinfo

FulfilmentInfo fulfilmentinfo

contains the fulfilemnt information

id

String id

A unique id given to the orderitem

inventory

Inventory inventory

Inventory information about the orderItem

item

Item item

Contains the orderItem's properties

lineid

long lineid

Indicates the unique line ID given to the order which is used while splitting

loyaltyDetails

LoyaltyDetails[] loyaltyDetails

contains the loyalty reward discount details

math

Math[] math

Math details about the order item

mathordershipping

Math[] mathordershipping

Math details about the order item for shipping

mathordertax

Math[] mathordertax

Math details about the order item for tax

nextstatus

String[] nextstatus

Next possible fulfilment status, the order item could be moved to

orderType

String orderType

originallineid

long originallineid

Indicates the line ID given to the order which is generated while creating the order

otherCharges

OtherCharges[] otherCharges

Specifies other charges for this orderitem.

otherproperties

HashMap<String,String> otherproperties

parentItemId

String parentItemId

parentLineId

String parentLineId

personalization

Personalization[] personalization

Personalization about the orderItem for the user

priceFacets

Map<String,Object> priceFacets

priceinfo

ItemPriceInfo[] priceinfo

quantity

BigDecimal quantity

Count of the item being ordered

returnable

boolean returnable

Indicates whether the product allowed to return

returnType

boolean returnType

Indicates whether the item is of type RETURN or not.

rewardmath

RewardMath[] rewardmath

RewardMath details about the order item

status

String status

Indicates the status

statustransaction

StatusTransaction[] statustransaction

Transactions made while changing the status

storeid

String storeid

storeLocation

StoreLocation storeLocation

StoreLocation

storename

String storename

taskid

String taskid

Class com.skava.oms.model.entity.order.OrderLock

class OrderLock extends Object implements Serializable

serialVersionUID:

-6140157979386957466L

Serialized Fields

component

Component component

The component which had acquired this lock

createdtime

long createdtime

Lock created time

id

String id

A unique id given to the order lock

user

String user

The user who had acquired this lock

Class com.skava.oms.model.entity.order.OrderProcessInfo

class OrderProcessInfo extends Object implements Serializable

serialVersionUID:

-8291461613143420674L

Serialized Fields

orderlock

OrderLock orderlock

Indicates whether the order is locked for any operation

usertaskinfo

UserTaskInfo[] usertaskinfo

Class com.skava.oms.model.entity.order.OrderTaxInfo

class OrderTaxInfo extends Object implements Serializable

serialVersionUID:

-3094400876123105657L

Serialized Fields

mode

String mode

taxcode

String taxcode

taxinfo

TaxInfo taxinfo

Class com.skava.oms.model.entity.order.OrderTransaction

class OrderTransaction extends Transaction implements Serializable

serialVersionUID:

-3893299565637552518L

Serialized Fields

math

Math math

orderitemid

String orderitemid

orderitemid

Class com.skava.oms.model.entity.order.OtherCharges

class OtherCharges extends Object implements Serializable

serialVersionUID:

-3736222523761433469L

Serialized Fields

calculatedTotalValue

BigDecimal calculatedTotalValue

Indicates the total calculated value this other charge element.

calculatedUnitValue

BigDecimal calculatedUnitValue

Indicates the calculated value per unit of this other charge element.

chargeAgainst

String chargeAgainst

Indicates if the variable cost is charged against returned item or new item.

chargeSource

String chargeSource

Indicates the source on which the percent charge needs to be applied.

chargeType

String chargeType

Indicates the charge type like percentage or flat rate to calculate the variable price.

chargeValue

BigDecimal chargeValue

Indicates value of this other charge element.

chargeValueOverridable

boolean chargeValueOverridable

Indicates whether this variable charge is editable or not.

description

String description

Holds the description of this other charge element.

mode

String mode

Name of the other mode.

name

String name

Name of the other charge.

properties

Map<String,String> properties

Indicates properties map.

taxable

boolean taxable

Indicates whether this variable price element is taxable or not.

type

String type

Indicates the type of the elements on which the variable price is applied.

waivedByDefault

boolean waivedByDefault

Indicates whether this variable cost is waived or not.

waiveOverridable

boolean waiveOverridable

Indicates whether this variable cost is waived or not.

Class com.skava.oms.model.entity.order.Payment

class Payment extends Object implements Serializable

serialVersionUID:

-6140157979386957466L

Serialized Fields

authToken

String authToken

Auth token

expDate

String expDate

Expiry date

firstName

String firstName

First Name

format

String format

Format used for payment

id

String id

Indicates the Unique Id for payment

lastName

String lastName

Last Name

mode

String mode

which mode the payment can be processed

paymentitems

PaymentItem[] paymentitems

Detailed information about the payment. Based on the maxamount the array will be extended

transaction

PaymentTransaction[] transaction

Indicates the transaction

type

String type

Type of the payment

value

BigDecimal value

Maximum amount processed via this payment type

Class com.skava.oms.model.entity.order.PaymentItem

class PaymentItem extends Object implements Serializable

serialVersionUID:

-8150429304766014123L

Serialized Fields

id

String id

Indicates the ID for the payment

inprocess

boolean inprocess

Indicates the transaction Id for the payment item

otherproperties

HashMap<String,String> otherproperties

Related details about the payment item in JSON format

paymentrefid

String paymentrefid

Indicates the payment reference id of the particular payment

status

PaymentStatus status

Indicates the current status of the particular payment

transactionid

String transactionid

Indicates the transaction Id for the payment item

transactiontype

PaymentServiceTransaction.Type transactiontype

Indicates the Transaction type for the payment item

value

BigDecimal value

Amount of payment processed by the particular provider

Class com.skava.oms.model.entity.order.PaymentTransaction

class PaymentTransaction extends Transaction implements Serializable

serialVersionUID:

-959979815994603459L

Serialized Fields

paymentrefid

String paymentrefid

transactioncode

String transactioncode

value

BigDecimal value

Class com.skava.oms.model.entity.order.Personalization

class Personalization extends Object implements Serializable

serialVersionUID:

-7986625854129817692L

Serialized Fields

id

String id

Contains the specific ID for personalization

message

String message

priceinfo

PersonalizationPriceInfo[] priceinfo

Contains the price information

receipt

boolean receipt

skuid

String skuid

wrap

String wrap

Class com.skava.oms.model.entity.order.PersonalizationPriceInfo

class PersonalizationPriceInfo extends Object implements Serializable

serialVersionUID:

3978078637305279746L

Serialized Fields

conversionratio

BigDecimal conversionratio

Mode in which the converionratio used to convert to product value is made

discount

Discount[] discount

discount information

mode

String mode

Mode in which the payment is made

taxinfo

TaxInfo taxinfo

Tax information

totalpersonalizationcost

BigDecimal totalpersonalizationcost

Math details about the order item

totalpersonalizationprice

BigDecimal totalpersonalizationprice

unitpersonalizationcost

BigDecimal unitpersonalizationcost

Cost for personalization

unitpersonalizationprice

BigDecimal unitpersonalizationprice

Class com.skava.oms.model.entity.order.RewardMath

class RewardMath extends Object implements Serializable

serialVersionUID:

7913575564821698804L

Serialized Fields

approvedPoints

BigDecimal approvedPoints

Contains the approved points

conversionratio

BigDecimal conversionratio

earnedPoints

BigDecimal earnedPoints

Contains the earned points

otherproperties

Map<String,String> otherproperties

Indicates any properties associated for that reward

reversedPoints

BigDecimal reversedPoints

Contains the reversed points

rewardType

String rewardType

Contains the rewardType

rewardValue

BigDecimal rewardValue

Contains the reward value

tier

String tier

Contains the tier

transaction

RewardTransaction[] transaction

Array of transactions made on the reward

transactionId

String transactionId

Indicates transactionId of the reward earned

transactionType

String transactionType

Contains the transactionType

voucherId

String[] voucherId

Indicates voucher id of the reward earned

Class com.skava.oms.model.entity.order.RewardTransaction

class RewardTransaction extends Transaction implements Serializable

serialVersionUID:

-959979815994603459L

Serialized Fields

eventId

String eventId

eventId in the loyalty transaction

rewardtype

String rewardtype

Reward type

transactiontype

String transactiontype

Reward's transaction type

value

BigDecimal value

value of reward

Class com.skava.oms.model.entity.order.ShippingMethod

class ShippingMethod extends Object implements Serializable

serialVersionUID:

-6832720171443808918L

Serialized Fields

code

String code

Shipping code of the shipping method which is customized based on the user

deliverystore

String deliverystore

Delivery store

deliveryterm

String deliveryterm

Delivery term

expectedshipmentdatetime

long expectedshipmentdatetime

User expected delivery in timestamp

name

String name

Name of the shipping method which is customized based on the user

otherproperties

HashMap<String,String> otherproperties

Extra properties about shipping

pickupPersonDetails

HashMap<String,String> pickupPersonDetails

pickupPersonDetails

priceinfo

ShippingMethodPriceInfo[] priceinfo

Class com.skava.oms.model.entity.order.ShippingMethodPriceInfo

class ShippingMethodPriceInfo extends Object implements Serializable

serialVersionUID:

3219191679547806766L

Serialized Fields

conversionratio

BigDecimal conversionratio

Mode in which the conversionratio is used to convert value

cost

BigDecimal cost

discountinfo

Discount[] discountinfo

Discount information

estcost

BigDecimal estcost

estprice

BigDecimal estprice

Estimated sale price for shipping

mode

String mode

Mode in which the payment is made

price

BigDecimal price

taxinfo

TaxInfo taxinfo

Tax information

Class com.skava.oms.model.entity.order.SpecialProductItemInfo

class SpecialProductItemInfo extends Object implements Serializable

serialVersionUID:

3629191715221923145L

Serialized Fields

categoryid

String categoryid

This is used to identify the category of this item

color

String color

description

String description

Detailed description about the item

dimension

String dimension

fit

String fit

image

String image

Image of the item. URL or file location of the item image

link

String link

Link of the item. link to the product detailes page

name

String name

Name of the item

size

String size

style

String style

Class com.skava.oms.model.entity.order.SpecialProducts

class SpecialProducts extends Object implements Serializable

serialVersionUID:

4410338067386902966L

Serialized Fields

actionhistory

ActionHistory[] actionhistory

aggregatestatus

String[] aggregatestatus

All fulfilment status, the special product is having

discounts

Discount[] discounts

displaystatus

String displaystatus

Display fulfilment status, the order item could be moved to

info

SpecialProductItemInfo info

itemMath

TotalValueMath itemMath

Specifies total Price, Pricefacets and Discounts.

nextstatus

String[] nextstatus

Next possible fulfilment status, the order item could be moved to

otherproperties

Map<String,String> otherproperties

price

BigDecimal price

This contains the price

priceFacets

Map<String,Object> priceFacets

productId

String productId

This contains the productid

skuId

@NotNull String skuId

This contains the skuid

skuQuantity

BigDecimal skuQuantity

This contains the skuquantity

status

String status

Indicates the status

tax

BigDecimal tax

Indicates the taxation details

type

String type

This contains the type

unitMath

TotalValueMath unitMath

Specifies unit Price, Pricefacets and Discounts.

Class com.skava.oms.model.entity.order.StatusTransaction

class StatusTransaction extends Object implements Serializable

serialVersionUID:

-1842636136695795411L

Serialized Fields

id

String id

status

String status

Class com.skava.oms.model.entity.order.StoreLocation

class StoreLocation extends Object implements Serializable

serialVersionUID:

-708745970428832521L

Serialized Fields

address

AddressRequest address

addressField

String addressField

binId

String binId

collectionId

long collectionId

distance

Double distance

distantUnit

DistantUnit distantUnit

enableShipFromStore

boolean enableShipFromStore

enableShipToStore

boolean enableShipToStore

enableStorePickup

boolean enableStorePickup

events

List<EventSchedule> events

hours

List<Hour> hours

identifier

String identifier

images

List<Image> images

isFromPropertyService

boolean isFromPropertyService

latitude

double latitude

locale

String locale

locationType

String locationType

longitude

double longitude

name

String name

properties

List<LocationProperty> properties

proximity

double proximity

status

LocationStatus status

tags

List<String> tags

timeZone

String timeZone

Class com.skava.oms.model.entity.order.SubmitToFulfilmentInfo

class SubmitToFulfilmentInfo extends Object implements Serializable

serialVersionUID:

6229573094189218389L

Serialized Fields

orderid

String orderid

Unique ID for fulfilment

returnaddress

Address returnaddress

returnmethod

ShippingMethod returnmethod

shipmentid

String shipmentid

Unique ID for Shipment

shippingaddress

Address shippingaddress

Address to which the orderitem to be shipped

shippingcontact

ContactInfo shippingcontact

shippingmethod

ShippingMethod shippingmethod

trackingurl

String trackingurl

Unique ID for Shipment

type

FulfilmentType type

Indicates which type of delivery process for this item. Ex: digital, Physical

Class com.skava.oms.model.entity.order.Tax

class Tax extends Object implements Serializable

serialVersionUID:

5379829626446791824L

Serialized Fields

billingAddress

TaxAddress billingAddress

The billingAddress Address.

currency

String currency

The currency.

deliverFromAddress

TaxAddress deliverFromAddress

The Delivery from Address.

deliverToAddress

TaxAddress deliverToAddress

The Delivery to Address.

itemDetails

List<Items> itemDetails

The shipping item details.

properties

Map<String,String> properties

The shipping custom properties as mapping object.

shippingDiscount

BigDecimal shippingDiscount

The shippingDiscount.

shippingPrice

BigDecimal shippingPrice

The shippingPrice.

shippingTaxationId

String shippingTaxationId

The shippingTaxationId.

taxId

String taxId

The taxId.

taxType

String taxType

The taxType.

Class com.skava.oms.model.entity.order.TaxAddress

class TaxAddress extends Object implements Serializable

serialVersionUID:

-6654169494859109945L

Serialized Fields

addressLine1

String addressLine1

The addressLine1.

addressLine2

String addressLine2

The addressLine2.

addressLine3

String addressLine3

The addressLine3.

addressVersion

long addressVersion

The shipping address Version.

canReceiveSMS

boolean canReceiveSMS

The canReceiveSMS.

city

String city

The city.

companyName

String companyName

The companyName.

country

String country

The country.

county

String county

The county.

email

String email

The email.

firstName

String firstName

The firstName.

lastName

String lastName

The lastName.

middleName

String middleName

The middleName.

mobile

String mobile

The mobile.

phone

String phone

The phone.

state

String state

The state.

zip

String zip

The zip.

Class com.skava.oms.model.entity.order.TaxInfo

class TaxInfo extends Object implements Serializable

serialVersionUID:

3441342007297719829L

Serialized Fields

esttax

BigDecimal esttax

isPriceInclusiveOftax

Boolean isPriceInclusiveOftax

tax

BigDecimal tax

taxable

BigDecimal taxable

taxrate

BigDecimal taxrate

Class com.skava.oms.model.entity.order.TaxItem

class TaxItem extends Object implements Serializable

serialVersionUID:

-1269653926410301942L

Serialized Fields

currencyCode

String currencyCode

id

String id

otherproperties

HashMap<String,String> otherproperties

profileId

String profileId

provider

String provider

status

String status

taxrefid

String taxrefid

taxTransactions

List<TaxTransaction> taxTransactions

transactionid

String transactionid

transactiontype

String transactiontype

value

int value

Class com.skava.oms.model.entity.order.TaxTransaction

class TaxTransaction extends Object implements Serializable

serialVersionUID:

-8240351285025026459L

Serialized Fields

component

int component

createdby

String createdby

createdTime

Date createdTime

currentstatus

String currentstatus

description

String description

id

long id

otherproperties

Map<String,String> otherproperties

refTransactionId

String refTransactionId

responsecode

String responsecode

responsemessage

String responsemessage

taxItemId

long taxItemId

transactioncode

String transactioncode

transactionType

TaxTransaction.TransactionType transactionType

type

String type

updatestatus

String updatestatus

value

BigDecimal value

Class com.skava.oms.model.entity.order.TotalValueMath

class TotalValueMath extends Object implements Serializable

serialVersionUID:

-1627666239047853983L

Serialized Fields

originalPrice

BigDecimal originalPrice

Indicates the original total price of all the SKU

priceAfterDiscount

BigDecimal priceAfterDiscount

Specifies the price after discount for all the SKU

priceFacets

Map<String,Object> priceFacets

Indicates the priceFacets of the SKU

priceRoundoff

BigDecimal priceRoundoff

Indicates the priceRoundoff of the sku

roundoff

BigDecimal roundoff

Indicates the round off discount value of the sku

tax

BigDecimal tax

Indicates the tax value of the sku price

taxRoundoff

BigDecimal taxRoundoff

Indicates the total taxRoundoff of the sku

totaldiscount

BigDecimal totaldiscount

Indicates the total discount of the sku

Class com.skava.oms.model.entity.order.Transaction

class Transaction extends Object implements Serializable

serialVersionUID:

5006848438123155895L

Serialized Fields

component

int component

component

createdby

String createdby

Indicates the created user

createdtime

long createdtime

Indicates the created time

currentstatus

String currentstatus

previousstatus

description

String description

id

String id

A unique id given to the Transaction

otherproperties

HashMap<String,String> otherproperties

responsecode

String responsecode

responsemessage

String responsemessage

type

TransactionType type

type

updatestatus

String updatestatus

nextstatus

Class com.skava.oms.model.entity.order.UserTaskInfo

class UserTaskInfo extends Object implements Serializable

serialVersionUID:

-4277554850004886085L

Serialized Fields

hasitemlevelprocessallowed

boolean hasitemlevelprocessallowed

Indicates whether user has item level process is allowed or not for approval

hasselfuseraccess

boolean hasselfuseraccess

Indicates whether user has self access for approval

nextstatus

String[] nextstatus

Tasks which has this next status will be updated

roles

List<String> roles

Indicates whether admin has roles to do task for the order

taskid

String[] taskid

Indicates the task Id of the task for the order

validationclass

String validationclass

Tasks which has this next status will be updated

Class com.skava.oms.model.entity.order.UserTracking

class UserTracking extends Object implements Serializable

serialVersionUID:

4409503675368275572L

Serialized Fields

accountid

String accountid

account id

budgetId

String budgetId

budget id

costcentre

String costcentre

costCentre

firstname

String firstname

First name of the user who placed the order

guestuser

boolean guestuser

guestuser

guestuserid

String guestuserid

ip

String ip

ip

lastname

String lastname

lastname

usercontact

ContactInfo usercontact

userid

String userid

zip

String zip

zip

Package com.skava.oms.model.request.collection

Class com.skava.oms.model.request.collection.CreateCollectionRequest

class CreateCollectionRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

1481771404945234280L

Serialized Fields

businessId

@jakarta.validation.constraints.Min(1L) long businessId

businessId

collection

@Valid @NotNull CollectionDTO collection

Contains the CollectionDTO object instance as the input for the collection request

Class com.skava.oms.model.request.collection.GetAllCollectionsRequest

class GetAllCollectionsRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

1L

Serialized Fields

businessId

@jakarta.validation.constraints.Min(0L) long businessId

This parameter will be available for all the services that acts on business level This parameter is used to mention the business Id to get all collections under that business id

filters

String filters

This recognize the search fields in the global orders

page

@jakarta.validation.constraints.Min(1L) int page

This parameter will be available for all the services that supports pagination. This parameter is used to mention the starting index of the items which going to responded by the API.

size

@jakarta.validation.constraints.Min(1L),@jakarta.validation.constraints.Max(100L) int size

This parameter will be available for all the services that supports pagination. This parameter is used to mention the number of maximum items that needs to be responded for the request.

sort

String sort

This recognize the sort fields in the global orders

Class com.skava.oms.model.request.collection.GetCollectionByIdRequest

class GetCollectionByIdRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

1L

Serialized Fields

businessId

Long businessId

id

@jakarta.validation.constraints.NotNull long id

Class com.skava.oms.model.request.collection.UpdateCollectionRequest

class UpdateCollectionRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

1L

Serialized Fields

businessId

@NotNull Long businessId

collection

@NotNull @Valid CollectionDTO collection

id

@jakarta.validation.constraints.NotNull long id

Package com.skava.oms.model.request.collection.properties

Class com.skava.oms.model.request.collection.properties.CollectionPropertiesRequest

class CollectionPropertiesRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

1L

Serialized Fields

businessId

long businessId

collectionId

long collectionId

collectionProperties

@Valid CollectionPropertiesDTO collectionProperties

Class com.skava.oms.model.request.collection.properties.UpdateCollectionPropertiesRequest

class UpdateCollectionPropertiesRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

1L

Serialized Fields

businessId

long businessId

collectionId

long collectionId

collectionProperties

CollectionPropertiesDTO[] collectionProperties

Package com.skava.oms.model.request.order

Class com.skava.oms.model.request.order.CreateOrderRequest

class CreateOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

collectionid

Long collectionid

locale

String locale

order

@Valid OrderDTO order

Class com.skava.oms.model.request.order.EditLockRequest

class EditLockRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-6080890281323063463L

Serialized Fields

collectionId

Long collectionId

This indicates the collection ID of the order

createdTime

long createdTime

Lock created time

editLockDTO

EditLockDTO editLockDTO

locale

String locale

lockDuration

int lockDuration

Indicates how long the order is locked for edit (Time in minutes)

orderId

String orderId

This indicates the identifier of the order, which has to be updated

Class com.skava.oms.model.request.order.GetAllLockedOrderRequest

class GetAllLockedOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

4207384934304473858L

Serialized Fields

collectionId

long collectionId

This recognize the collection ID of the order

filters

String filters

This recognize the search fields in the global orders

page

@jakarta.validation.constraints.Min(1L) int page

size

@jakarta.validation.constraints.Min(1L),@jakarta.validation.constraints.Max(100L) int size

skipTotalCount

boolean skipTotalCount

sort

String sort

This recognize the sort fields in the global orders

Class com.skava.oms.model.request.order.GetAllOrderRequest

class GetAllOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

4411264426017932441L

Serialized Fields

accountid

Long accountid

This recognize the accountid fields in the global orders

archive

boolean archive

collectionId

long collectionId

This recognize the collection ID of the order

countOnly

boolean countOnly

countOnly

filters

String filters

This recognize the search fields in the global orders

lookup

boolean lookup

This recognize the lookup for the guest search to be searched in the global orders

page

@jakarta.validation.constraints.Min(1L) int page

size

@jakarta.validation.constraints.Min(1L),@jakarta.validation.constraints.Max(100L) int size

This parameter will be available for all the services that supports pagination. This parameter is used to mention the number of maximum items that needs to be responded for the request.

skipTotalCount

boolean skipTotalCount

This recognize the user need to skip the total count

sort

String sort

This recognize the sort fields in the global orders

userid

String userid

This recognize the user id to be searched in the order

Class com.skava.oms.model.request.order.GetOrderRequest

class GetOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

archive

boolean archive

Field to decide the data is fetched from Primary or Archive

collectionid

long collectionid

This recognize the collection Id to search for the sku.

orderid

String orderid

This recognize the order Id to search for the sku.

userid

String userid

This recognize the user Id to search for the sku.

Class com.skava.oms.model.request.order.GetOrderSummaryRequest

class GetOrderSummaryRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

collectionid

long collectionid

This recognize the collection Id to search for the sku.

filters

String filters

This recognize the search fields in the global orders

page

@jakarta.validation.constraints.Min(1L) int page

size

@jakarta.validation.constraints.Min(1L),@jakarta.validation.constraints.Max(100L) int size

This parameter will be available for all the services that supports pagination. This parameter is used to mention the number of maximum items that needs to be responded for the request.

sort

String sort

This recognize the sort fields in the global orders

startDate

Date startDate

This recognize the order Id to search for the sku.

Class com.skava.oms.model.request.order.GetSkuRequest

class GetSkuRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

archive

boolean archive

This Param used to Decide if the data is fetched from Primary or Archive.

collectionid

long collectionid

This recognize the collection Id to search for the sku.

userid

String userid

This recognize the user Id to search for the sku.

Class com.skava.oms.model.request.order.LockOrderRequest

class LockOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

collectionId

Long collectionId

component

Component component

orderId

String orderId

user

String user

Class com.skava.oms.model.request.order.MessageResendRequest

class MessageResendRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-8139049383462722600L

Serialized Fields

collectionId

Long collectionId

This indicates the collection ID of the order

locale

String locale

This indicates the locale of the request

messageResendPatchFieldsDTO

@Valid MessageResendPatchFieldsDTO messageResendPatchFieldsDTO

orderId

String orderId

This indicates the identifier of the order, which has to be updated

queueName

String queueName

This indicates the queue name in which the message has to be pushed

Class com.skava.oms.model.request.order.OrderConfiguration

class OrderConfiguration extends Object implements Serializable

serialVersionUID:

-1286058704050682517L

Serialized Fields

action

String action

This recognize the action fields in the OrderConfiguration model workflow

eventName

String eventName

This recognize the event name fields in the OrderConfiguration model workflow

hasSelfAccess

boolean hasSelfAccess

This recognize the whether update can be done by self user fields in the OrderConfiguration model workflow

returnExpirationDays

String returnExpirationDays

This recognize the return expiration days fields in the OrderConfiguration model workflow

roles

List<String> roles

Indicates whether admin has roles to do task for the order

status

String status

This recognize the status fields in the OrderConfiguration model workflow

validationClass

String validationClass

Tasks which has this next status will be updated

Class com.skava.oms.model.request.order.PatchLockedOrderRequest

class PatchLockedOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

6241669666413216165L

Serialized Fields

collectionId

Long collectionId

This indicates the collection ID of the order

locale

String locale

This indicates the locale of the request

lockedOrderPatchFieldsDTO

@Valid LockedOrderPatchFieldsDTO lockedOrderPatchFieldsDTO

orderId

String orderId

This indicates the identifier of the order, which has to be updated

Class com.skava.oms.model.request.order.PatchOrderRequest

class PatchOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

collectionId

Long collectionId

This indicates the collection ID of the order

locale

String locale

This indicates the locale of the request

orderId

String orderId

This indicates the identifier of the order, which has to be updated

orderPatchDTO

@Valid OrderPatchDTO orderPatchDTO

Class com.skava.oms.model.request.order.ReturnLabelRequest

class ReturnLabelRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

collectionId

long collectionId

This recognize the collection Id to search for the sku.

itemId

String itemId

This recognize the item Id of an order.

orderId

String orderId

This recognize the order Id to search for the sku.

Class com.skava.oms.model.request.order.UpdateOrderRequest

class UpdateOrderRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

8057653683457662113L

Serialized Fields

collectionid

Long collectionid

locale

String locale

order

@Valid OrderDTO order

orderId

String orderId

This indicates the identifier of the order, which has to be updated

Package com.skava.oms.model.request.order.note

Class com.skava.oms.model.request.order.note.CreateNoteRequest

class CreateNoteRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

collectionid

Long collectionid

collectionid - id of the collection in process

locale

String locale

This indicates the locale of the request

noteDTO

@Valid NoteDTO noteDTO

note to be updated in the order

orderid

String orderid

orderid - id of the order in process

Package com.skava.oms.model.request.order.notification

Class com.skava.oms.model.request.order.notification.UpdateNotificationRequest

class UpdateNotificationRequest extends com.skava.core.validation.InputModel implements Serializable

serialVersionUID:

-1034146104654695965L

Serialized Fields

collectionid

Long collectionid

collectionid - id of the collection in process

locale

String locale

This indicates the locale of the request

notificationPatchDTO

@Valid NotificationPatchDTO notificationPatchDTO

notification to be updated in the order

orderid

String orderid

orderid - id of the order in process

Package com.skava.oms.model.response

Class com.skava.oms.model.response.CommonPluginProcessorResponse

class CommonPluginProcessorResponse extends Object implements Serializable

serialVersionUID:

-158827393534748115L

Serialized Fields

errorcode

String errorcode

response code from third party services

errormessage

String errormessage

response message from third party services

properties

String properties

properties required for further processing in oms This is usually a JSON string

Class com.skava.oms.model.response.OmsServiceEntityResponse

class OmsServiceEntityResponse extends com.skava.core.validation.OutputModel implements Serializable

serialVersionUID:

-5866536044011868761L

Serialized Fields

code

ResponseCode code

count

Long count

Class com.skava.oms.model.response.OmsServiceErrorCodeResponse

class OmsServiceErrorCodeResponse extends com.skava.core.ResponseModel implements Serializable

serialVersionUID:

1L

Serialized Fields

pluginResponse

CommonPluginProcessorResponse pluginResponse

status

org.springframework.http.HttpStatus status

status of the collection to find and response.

validationErrors

ValidationErrorModel validationErrors

Class com.skava.oms.model.response.OrderSummaryResponse

class OrderSummaryResponse extends Object implements Serializable

serialVersionUID:

8385198418165757036L

Serialized Fields

averageOrderAmount

BigDecimal averageOrderAmount

Indicates the averageOrderAmount given to the order

backOrder

long backOrder

Indicates the backOrder for the particular order

date

long date

Indicates the date information about the order

failedOrder

long failedOrder

Indicates the failedOrder for the order

inProgressOrders

long inProgressOrders

Indicates the inProgressOrders given to the order

orderTotal

BigDecimal orderTotal

Indicates the orderTotal information about the order

totalOrder

long totalOrder

Indicates the backOrder for the particular order

Class com.skava.oms.model.response.ReturnLabelResponse

class ReturnLabelResponse extends Object implements Serializable

serialVersionUID:

8385198418165757036L

Serialized Fields

itemId

String itemId

Indicates the ID of an item of an order.

label

byte[] label

Contains return label information.

Class com.skava.oms.model.response.SkuResponse

class SkuResponse extends Object implements Serializable

serialVersionUID:

8385198418165757036L

Serialized Fields

skuId

String skuId

Indicates the ID of the SKU of the order.

total

int total

Contains the total number of quantity for the skuId.

Package com.skava.oms.validator.response

Class com.skava.oms.validator.response.ValidationErrorModel

class ValidationErrorModel extends Object implements Serializable

serialVersionUID:

6770233622099652219L

Serialized Fields

fieldErrors

ValidationFieldErrorModel[] fieldErrors

fieldErrors

globalErrors

ValidationGlobalErrorModel[] globalErrors

globalErrors

Class com.skava.oms.validator.response.ValidationErrorResponse

class ValidationErrorResponse extends com.skava.core.ResponseModel implements Serializable

serialVersionUID:

-4074424525367593318L

Serialized Fields

validationErrors

ValidationErrorModel validationErrors

Class com.skava.oms.validator.response.ValidationFieldErrorModel

class ValidationFieldErrorModel extends Object implements Serializable

serialVersionUID:

-8304760824219203394L

Serialized Fields

code

String code

field

String field

message

String message

rejectedValue

String rejectedValue

Class com.skava.oms.validator.response.ValidationGlobalErrorModel

class ValidationGlobalErrorModel extends Object implements Serializable

serialVersionUID:

-1601982831803168203L

Serialized Fields

code

String code

message

String message