HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Order Promotion_items

Data structure of a promotion item

FieldColumn TypeDescriptionExample
idStringOrder item's ID (ID of an order item's collection, including item_type, item_id..and so on)
系統自行創建訂單折扣ID
5de71987202bf4001574ecfd
discountable_amount
discounted_amountMoneyDiscounted Amount
折扣金額
1125
subtotal_afterMoneySubtotal After Discount
折扣後訂單金額
5125
promotionPromotion ]Promotion Data
促銷資訊
item_dataObjectcart item snapshot
購物車快照
updated_atDateTimePromotion Updated Time
此產品使用促銷更新時間
2019-12-04T02:27:20.087+00:00
created_atDateTimePromotion Created Time
此產品使用促銷創造時間(通常與產品創造時間一致)
2019-12-04T02:27:20.081+00:00

JSON example

{
  "promotion_items":[
{
         "discounted_amount" : {
            "label" : "",
            "currency_iso" : "USD",
            "cents" : 0,
            "currency_symbol" : "US$",
            "dollars" : 0
         },
         "promotion" : {
            "merchant_id" : "5ef06673dd398e02251a219c",
            "discountable_product_ids" : [
               "5f9bc6fee3880957b929358c"
            ],
            "seo_description_translations" : {},
            "extended_promotion_id" : null,
            "use_count" : 5,
            "whitelisted_tag_contents" : [],
            "discount_on" : "order",
            "banner_media_ids" : [],
            "updated_at" : "2020-12-24T10:14:37.802+00:00",
            "requires_membership" : false,
            "discounted_price" : null,
            "discount_type" : "gift",
            "membership_tier_id" : null,
            "seo_keywords" : null,
            "multiple_code" : false,
            "codes" : [],
            "discounted_point" : null,
            "status" : "removed",
            "is_accumulated" : false,
            "end_at" : null,
            "user_max_use_count" : 0,
            "id" : "5f9bc903e3880957b92935bb",
            "created_at" : "2020-10-30T08:04:19.320+00:00",
            "discount_percentage" : null,
            "seo_title_translations" : {},
            "discountable_category_ids" : [],
            "show_coupon" : false,
            "start_at" : "2020-10-30T08:00:00.000+00:00",
            "addon_product_id" : null,
            "for_affiliate_campaign" : false,
            "_id" : "5f9bc903e3880957b92935bb",
            "title_translations" : {
               "en" : "free"
            },
            "term_translations" : {},
            "max_use_count" : null,
            "discount_amount" : null,
            "min_price_type" : "after_discount",
            "description_translations" : {},
            "discountable_quantity" : 1
         },
         "item_data" : {
            "type" : "promotion",
            "promotion_id" : "5f9bc903e3880957b92935bb",
            "tax_region_id" : null,
            "_id" : "5f9ecb37e388093b03e14a18",
            "item_data" : {},
            "triggering_item_id" : null,
            "subscription_order_id" : null,
            "variation_id" : null,
            "quantity" : 1,
            "tax_price" : null,
            "custom_price" : null,
            "product_id" : null,
            "addon_feature_id" : null,
            "parent_item_ids" : []
         },
         "created_at" : "2020-11-01T14:50:32.039+00:00",
         "id" : "5f9ecb37e388093b03e14a1a",
         "discountable_amount" : null,
         "updated_at" : "2020-11-01T14:50:32.052+00:00",
         "subtotal_after" : {
            "cents" : 1200,
            "currency_iso" : "HKD",
            "label" : "HK$12.00",
            "dollars" : 12,
            "currency_symbol" : "HK$"
         }
      }
  ]
}