Fee Details
A fee is a rate card agreed between portal and its contact. Eshopbox allows you to configure such rate cards into a set of rules.
The Fee Details
Object
Fee Details
ObjectAttributes | Type | Description |
|
| Unique Id for fee created or Unique Id for already present fee |
|
| Name of the created fees |
|
| Receivable fee Name from portal |
|
| Id for a portal (Ex. Amazon, Flipkart) for which fees is created |
|
| Portal Name for which fee is configured |
|
| Unique Id for a fee on a particular portal |
|
| Version of the fees created |
|
| Fees is tax inclusive or not Refer |
|
| Percentage of tax applicable on a fee |
|
| Status of the fees
Refer |
|
| "YES" if fee is editable else "NO" |
|
| Portal Logo Url |
| An array of fee rules. Also see: The details object below. | |
| An array of Fee Event Mapping. Also see: The feeEventMappingDetail object below. | |
|
| Datetime from which fees will be activated |
|
| Datetime at which fees will be expired |
|
| The datetime, at which fees is created |
|
| The datetime, at which fees is updated |
Enum: status
Attributes | Description |
| This is the applicable fee for the current period. |
| Fee for which validity has expired. |
| Fee which will be applicable from a future date. |
Enum: isInclusiveTax
Attributes | Description |
| Fee is tax inclusive |
| Fee is not tax inclusive |
A details
Object
details
ObjectAttributes | Type | Description |
| System details | |
|
| Brands for which rule is created. |
|
| Action to be considered for fee rules. |
|
| Mode of payment Refer |
|
| Fee value which is fixed for the rule and would not vary. |
|
|
|
|
| Fee Rule Condition Id |
|
| Unique Id for a fee on particular portal |
|
| Fee Version for fees |
|
| Unique Id for Fee |
|
| portal for which fee is configured |
|
| Categories for which rule is created. |
|
| Mongo rule for particular Id |
|
| Percentage value to be considered for the rule. |
|
|
|
| array of product selling price Also see: The productsellingprice object | |
| array of weight range Also see: The weightrange object | |
|
| Fee value which will vary with different conditions. |
|
|
|
|
| Change in Variable value added as per defined units. |
|
| Partition Range Unit |
|
| Zone to which order is shipped |
Enum: feeRuleStatus
Attributes | Description |
| Out of all the THEN condition defined for fees, greatest amount will be considered. |
| Out of all the THEN condition defined for fees, lowest amount will be considered. |
| Sum of all the THEN condition defined for fees is considered. |
Enum: applicableOn
Attributes | Description |
| Fee Rule to be considered Per Order |
| Fee Rule to be considered Per Order Item |
| Fee Rule to be considered Per Shipment |
Enum: paymentMethod
Attributes | Description |
| Payment is done before shipment |
| Payment is done at the time of delivery |
The productsellingprice
object
productsellingprice
objectAttributes | Type | Description |
|
| currency(INR) |
|
| Maximum value of PSP range |
|
| Minimum value of PSP range |
The weightrange
object
weightrange
objectAttributes | Type | Description |
|
| unit of weight(kg) |
|
| Maximum value of weight range |
|
| Minimum value of weight range |
The _id
object
_id
objectAttributes | Type | Description |
|
| Timestamp of fees creation |
|
| Machine Identifier |
|
| Process identifier |
|
| Counter |
|
| Time of fees creation |
|
| Date of fees creation |
|
| Time second for fees creation |
The feeEventMappingDetail
object
feeEventMappingDetail
objectAttribute | Type | Description |
|
| Unique Id for each rule |
|
| Unique Id for a fee on particular portal |
|
| Type of fee charged |
|
| Detail of when fee is charged |
|
| "CUSTOMER" or "COURIER" in case of "RETURNED" event type. |
|
| Percentage of fee to be charged |
|
| The time, on which fee is created |
|
| The time, on which fee is updated |
Enum: eventType
Attributes | Description |
| Fee is applicable when the order is returned |
| Fee is applicable when the order is shipped |
| Fee is applicable when the order is cancelled |
Last updated