promocode
This object contains promotion code information for the order.
Field Name |
Field Type |
Description |
In Get Functions? |
In Set Functions? |
---|---|---|---|---|
discountamount |
string |
Currency amount of the discount applied to the order. |
yes |
no |
errormsg |
string |
Returns the error message when a promo code is not valid. |
yes |
no |
internalid |
string |
Internal ID |
yes |
no |
isvalid |
string |
Indicates whether promocode is valid for the current order. Value should be T or F. |
yes |
no |
promocode |
string |
The value of the Coupon Code ID. This corresponds to what the user sets during the checkout process. |
yes |
yes |
promocodeid |
string |
The value of the Promocode ID. This corresponds to the promocode displayed in the NetSuite UI.
Note:
The value of this field is not changed when a coupon code is modified. |
yes |
yes |
purchase_ |
string |
Currency amount of the discount applied to the order. |
yes |
no |
purchase_ |
string |
Discount amount formatted with currency symbol. |
yes |
no |
shipping_ |
string |
Currency amount of the discount applied to the shipping cost. |
yes |
no |
shipping_ |
string |
Discount shipped amount formatted with currency symbol. |
yes |
no |
promotion_name |
string |
Name of the promotion associated with the applied coupon. |
yes |
no |
discount_name |
string |
Name of the discount associated with the applied promotion. |
yes |
no |
discount_type |
string |
Indicates the type of discount, and its value should be PERCENTAGE or FLAT. |
yes |
no |
discount_rate |
string |
Rate of the discount in percentage if the type of discount is PERCENTAGE and currency amount of the discount if the type of discount is FLAT. |
yes |
no |
is_auto_applied |
boolean |
Indicates whether the promocode was automatically or manually applied for the current order. Value should be true or false. |
yes |
no |
applicability_status |
string |
Indicates whether the promocode is applied to the current order or not. Value should be one of the following:
|
yes |
no |
applicability_reason |
string |
Specifies the reason for not applying the promocode. Value should be one of the following:
|
yes |
no |
promotion_type |
string |
Indicates the type of promotion. |
yes |
no |