Fields
added_to_fynd_cash
BooleanIndicates if the refund amount was added to Fynd Cash. For example, `added_to_fynd_cash` can be set to true.
amount_paid
FloatThe total amount paid by the customer. Calculated as price_effective + cod_charges + delivery_charge + article_charge - coupon_effective_discount - promotion_effective_discount - referral_credits - cashback - gift_card_amount - employee_discount - loyalty_discount (must be non-negative).
amount_paid_roundoff
FloatThe rounded-off amount paid by the customer. For example, `amount_paid_roundoff` can be set to 2499.5.
brand_calculated_amount
FloatThe amount paid to the brand after subtracting all seller-funded discounts. It represents the brand’s net receivable calculated as: BCA = price_effective - coupon_effective_discount (seller) - promotion_effective_discount (seller).
cashback
FloatThe cashback amount earned. For example, `cashback` can be set to 99.99.
cashback_applied
FloatThe amount of cashback applied. For example, `cashback_applied` can be set to 99.99.
cod_charges
FloatThe cash on delivery charges, if applicable. For example, `cod_charges` can be set to 99.99.
coupon_effective_discount
FloatThe effective discount from coupons. If `coupon_effective_discount` is provided, the accompanying coupon_json payload must not be empty.
coupon_value
FloatThe value of the coupon applied. For example, `coupon_value` can be set to 2499.5.
delivery_charge
FloatThe delivery charge for the order. Included in amount_paid and amount_to_be_collected calculations.
discount
FloatDiscount = price_marked (MRP) - price_effective; cannot be negative.
fynd_credits
FloatThe amount of Fynd credits used. For example, `fynd_credits` can be set to 99.99.
gst_fee
FloatThe GST fee applied to the item; used when deriving Value of Good (VOG).
gst_tag
StringThe GST tag indicating the type of GST applied. For example, `gst_tag` can be set to 'value'.
gst_tax_percentage
FloatThe GST tax percentage applied . For example, `gst_tax_percentage` can be set to 0.18.
hsn_code
StringThe HSN (Harmonized System of Nomenclature) code of the item. For example, `hsn_code` can be set to 'sample_code'.
identifiers
IdentifiersSchema for identifiers. For example, `identifiers` can be set to a Identifiers object.
item_name
StringThe name of the item. For example, `item_name` can be set to 'Sample Name'.
price_effective
FloatThe effective price after all adjustments; must not exceed price_marked/MRP.
price_marked
FloatThe original marked price (MRP) of the item; must be greater than or equal to price_effective.
promotion_effective_discount
FloatThe effective discount from promotions (seller/marketplace) used in BCA and collection calculations.
refund_amount
FloatThe amount refunded to the customer. For example, `refund_amount` can be set to 2499.5.
refund_credit
FloatThe amount credited for refund . For example, `refund_credit` can be set to 99.99.
size
StringThe size of the item . For example, `size` can be set to 'value'.
total_units
IntThe total number of units purchased. For example, `total_units` can be set to 2.
transfer_price
FloatThe transfer price of the item. For example, `transfer_price` can be set to 2499.5.
value_of_good
FloatValue of Good (VOG). VOG = brand_calculated_amount - GST amount (e.g., gst_fee or summed taxes).
amount_to_be_collected
FloatNet amount that needs to be collected: price_effective + cod_charges + delivery_charge - coupon_effective_discount - promotion_effective_discount - referral_credits - cashback - customer credit note - gift card - employee_discount - loyalty_discount - sodexo (where applicable).
taxes
[TaxComponent]Applied Tax Components. For example, `taxes` can be set to [a TaxComponent object].
loyalty_discount
FloatAmount reduced from the payable price when the customer applies loyalty program points while placing the order; also impacts amount_paid and amount_to_be_collected.
Was this section helpful?