Get Affiliate Campaign Order Usage
Function
To get orders using a specific affiliate code or campaign ID
獲取使用特定推薦活動代碼的訂單
URL
GET <<api_domain>>/v1/affiliate_campaigns/:id/orders
Request Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| id *Required | String | Affiliate campaign ID 推薦活動 ID | 6049d431709478001d7c496b |
| previous_id | string | The last ID of the orders in the previous request. 上一次請求中拿到的最後一個 order_id | 5ce0d084e388096bdb229a58 |
| limit | Integer | Numbers of Orders 顯示 n 筆訂單 | 24 |
Request Example
curl --location --request GET '<<api_domain>>/v1/affiliate_campaigns/:id/orders' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer your token' \
--header 'Content-Type: application/json'
Response Fields
| Field | Type | Description | Example |
|---|---|---|---|
| items | Array of Order | Order Information 訂單資訊 | [] |
| limit | Integer | Numbers of Orders 顯示 n 筆訂單 | 24 |
| last_id | String | The last ID of the orders. 該次請求最後一筆 order_id | 5ce0d084e388096bdb229a58 |
Sample Response
{
"items": [
{
"id": "6386cd0b31b641004798fb00",
"order_number": "20221130032459200",
"system_order_number": "20221130032459200",
"merchant_order_number": null,
"status": "pending",
"is_guest_checkout": false,
"order_remarks": "",
"order_payment": {
"id": "6386cd0b31b641004798fb00",
"payment_method_id": "6195c15629166a3f7132fd00",
"payment_type": "custom",
"name_translations": {
"zh-hant": "自訂1.8%附加費",
"zh-cn": "",
"vi": "",
"ms": "",
"ja": "",
"th": "",
"id": "",
"de": "",
"fr": ""
},
"status": "pending",
"payment_fee": {
"cents": 3,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$3",
"dollars": 3
},
"total": {
"cents": 123,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$123",
"dollars": 123
},
"paid_at": null,
"updated_at": "2022-11-30T03:25:00.592Z",
"created_at": "2022-11-30T03:24:59.344Z",
"payment_data": {},
"last_four_digits": "",
"ref_payment_id": null,
"payment_slips_setting": {
"enabled": false,
"days_of_guest_view": 1
}
},
"customer_id": "638640b85494b700252c3c40",
"currency_iso": "TWD",
"subtotal": {
"cents": 110,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$110",
"dollars": 110
},
"order_discount": {
"cents": 10,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$10",
"dollars": 10
},
"user_credit": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "",
"dollars": 0
},
"total_tax_fee": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "",
"dollars": 0
},
"total": {
"cents": 123,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$123",
"dollars": 123
},
"order_points": 0,
"order_points_to_cash": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "",
"dollars": 0
},
"subtotal_items": [
{
"id": "6386cd0b31b641004798fb00",
"item_type": "Product",
"item_id": "6336b45fe0749800070a5500",
"item_price": {
"cents": 100,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$100",
"dollars": 100
},
"ref_data": null,
"product_subscription_id": null,
"quantity": 1,
"total": {
"cents": 100,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$100",
"dollars": 100
},
"item_data": {
"cart_item_id": "1026994",
"promotion_id": null,
"parent_item_ids": [],
"triggering_item_id": "",
"order_promotion_items": {
"order_discounted_price": "6386cd0b31b641004798fb00"
},
"order_discounted_price": {
"cents": 10,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$10",
"dollars": 10
},
"has_exclude_promotion_tag": false,
"variation_data": {
"_id": "6336b460ddbb69000763bd00",
"barcode_type": "Code 128",
"cost": {
"cents": 60,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$60",
"dollars": 60
},
"created_at": "2022-09-30T09:18:25.102Z",
"feed_variations": null,
"fields": [
{
"name_translations": {
"en": "",
"zh-hant": "S",
"zh-cn": "",
"ms": "",
"ja": "",
"th": "",
"de": "",
"fr": "",
"vi": "",
"id": ""
}
}
],
"fields_translations": {
"en": [],
"zh-hant": [
"S"
],
"zh-cn": [],
"ms": [],
"ja": [],
"th": [],
"de": [],
"fr": [],
"vi": [],
"id": []
},
"gtin": "26035474",
"key": "6336b460ddbb69000763bd00",
"location_id": null,
"max_order_quantity": 10,
"media_id": null,
"member_price": {
"cents": 100,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$100",
"dollars": 100
},
"mpn": null,
"out_of_stock_orderable": false,
"price": {
"cents": 250,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$250",
"dollars": 250
},
"price_sale": {
"cents": 200,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$200",
"dollars": 200
},
"retail_price": 150,
"root_product_variation_id": null,
"sku": "sku_import31",
"stock_ids": null,
"tier_member_price": {
"5f9fd59ae38809546edb0282": 90,
"601d0d68ae614b435b800229": 80,
"632d76aaf20c730035f8214d": 70
},
"unlimited_quantity": null,
"updated_at": "2022-09-30T09:18:25.326Z",
"variant_option_ids": [
"6336b4617f35ba000b8ad200"
],
"wapos_id": null,
"weight": 0,
"media_hash": {}
}
},
"item_variation_id": "6336b460ddbb69000763bd00",
"item_variation_key": "6336b460ddbb69000763bd00",
"price": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "",
"dollars": 0
},
"price_sale": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$0",
"dollars": 0
},
"cost": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$0",
"dollars": 0
},
"title_translations": {
"en": "",
"zh-hant": "import3",
"zh-cn": "",
"ms": "",
"ja": "",
"th": "",
"de": "",
"fr": "",
"vi": "",
"id": ""
},
"fields_translations": {
"en": [],
"zh-hant": [
"S"
],
"zh-cn": [],
"ms": [],
"ja": [],
"th": [],
"de": [],
"fr": [],
"vi": [],
"id": []
},
"sku": "sku_import31",
"is_preorder": false,
"order_discounted_price": {
"cents": 10,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$10",
"dollars": 10
},
"media": {
"images": {
"original": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"favicon_small": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"favicon": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"favicon_large": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"transparent_thumb": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"transparent_large": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"transparent_xlarge": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"thumb": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
},
"source": {
"width": 800,
"height": 533,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6336b460ddbb69000763bd5a/original.jpeg?1664529504"
}
},
"_id": "6336b460ddbb69000763bd5a",
"alt_translations": {}
},
"discounted_price": null,
"created_by": "admin",
"object_data": {
"gender": "unisex",
"age_group": "adult",
"adult": "no",
"condition": "new",
"status": "active"
}
},
{
"id": "6386cd0b31b641004798fb00",
"item_type": "AddonProduct",
"item_id": "62986341a5fbef0032511f00",
"item_price": {
"cents": 10,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$10",
"dollars": 10
},
"ref_data": null,
"product_subscription_id": null,
"quantity": 1,
"total": {
"cents": 10,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$10",
"dollars": 10
},
"item_data": {
"cart_item_id": "1026996",
"promotion_id": "62d6549e129743003b33d900",
"parent_item_ids": [
"6386cd0b31b641004798fb70"
],
"triggering_item_id": "",
"triggering_product_id": ""
},
"item_variation_id": "",
"item_variation_key": "",
"price": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "",
"dollars": 0
},
"price_sale": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$0",
"dollars": 0
},
"cost": {
"cents": 0,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$0",
"dollars": 0
},
"title_translations": {
"en": "Add-ons 15",
"zh-hant": "加購品15"
},
"fields_translations": {},
"sku": "",
"is_preorder": false,
"order_discounted_price": null,
"media": {
"images": {
"original": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"favicon_small": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"favicon": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"favicon_large": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"transparent_thumb": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"transparent_large": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"transparent_xlarge": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"thumb": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
},
"source": {
"width": 526,
"height": 522,
"url": "https://img-shoplineapp-com.s3.amazonaws.com/media/image_clips/6298633fa5fbef0038511f25/original.png?1654154046"
}
},
"_id": "6298633fa5fbef0038511000",
"alt_translations": {}
},
"discounted_price": null,
"created_by": "admin",
"object_data": {
"status": "active",
"weight": 0,
"barcode_type": "Code 128",
"gtin": "39585937"
}
}
],
"promotion_items": [
{
"id": "6386cd0b31b641004798fb00",
"discountable_amount": null,
"discounted_amount": {
"cents": 10,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$10",
"dollars": 10
},
"subtotal_after": {
"cents": 90,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$90",
"dollars": 90
},
"updated_at": "2022-11-30T03:24:59.244Z",
"created_at": "2022-11-30T03:24:59.244Z",
"coupon_code": null,
"promotion": {
"_id": "62fdde8f430cb800388c0e00",
"addon_product_id": null,
"available_platforms": [
"ec"
],
"banner_media_ids": [],
"codes": [],
"coupon_generated_by": "manual",
"coupon_type": "single",
"created_at": "2022-08-18T06:39:12.006Z",
"description_translations": {},
"discount_amount": null,
"discount_on": "order",
"discount_percentage": 10,
"discount_type": "percentage",
"discountable_category_ids": [],
"discountable_product_ids": [],
"discountable_quantity": null,
"discounted_point": null,
"discounted_price": null,
"drew_coupon_count": 0,
"end_at": null,
"extended_promotion_id": null,
"first_purchase_only": false,
"for_affiliate_campaign": false,
"is_accumulated": false,
"max_use_count": null,
"membership_tier_id": null,
"merchant_id": "5afaa3b0e38809312d000000",
"min_price_type": "after_discount",
"multiple_code": false,
"requires_membership": false,
"seo_description_translations": {},
"seo_keywords": "",
"seo_title_translations": {},
"show_coupon": false,
"start_at": "2022-08-18T06:00:00.000Z",
"status": "active",
"term_translations": {},
"title_translations": {
"zh-hant": "全單折扣"
},
"updated_at": "2022-08-23T04:34:13.390Z",
"use_count": 45,
"user_max_use_count": 0,
"whitelisted_tag_contents": [],
"is_extend_promotion": false,
"id": "62fdde8f430cb800388c0edb"
},
"item_data": null,
"promotion_conditions_data": [
{
"min_item_count": null,
"min_price": {
"cents": 100,
"currency_iso": "TWD"
},
"type": null,
"whitelisted_product_ids": [],
"whitelisted_category_ids": [],
"blacklisted_product_ids": [],
"id": "62fdde8f430cb800388c0e00"
}
]
}
],
"custom_discount_items": [],
"ref_order_id": "",
"ref_customer_id": "",
"parent_order_id": "",
"child_order_ids": [],
"split_at": null,
"confirmed_at": null,
"updated_at": "2022-11-30T03:25:09.303+00:00",
"created_at": "2022-11-30T03:24:59.167+00:00",
"utm_data": {},
"created_by": "shop",
"created_from": "shop",
"affiliate_campaign": {
"id": "6386cd0b31b641004798fb00",
"name_translations": {
"en": "o4o555 (with reward)"
},
"type": "affiliate_referral",
"reward_type": "percentage",
"reward_value": {
"cents": 1,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$1",
"dollars": 1
},
"campaign_id": "6373673f12e93f0039dfe995",
"order_id": "6386cd0b31b6410047989973",
"bonus_balance": {
"cents": 100,
"currency_symbol": "NT$",
"currency_iso": "TWD",
"label": "NT$100",
"dollars": 100
},
"campaign_data": {
"_id": "6373673f12e9399039dfe055",
"code": "o4o555",
"condition_value": 97,
"created_at": "2022-11-15T10:17:35.359Z",
"end_at": null,
"merchant_id": "5afaa3b0e38809399d00002e",
"name_translations": {
"en": "code"
},
"partner_info": {},
"promotion_id": null,
"remarks_translations": {
"zh-hant": "活動"
},
"reward_type": "percentage",
"reward_value": 1,
"start_at": "2022-11-15T10:00:00.000Z",
"status": "active",
"type": "affiliate_referral",
"updated_at": "2022-11-15T10:17:35.359Z"
}
},
"inclusive_tax_info": {}
}
],
"limit": 24,
"last_id": "6386cd0b31b641004798fb00"
}
Updated about 1 month ago